Sign in

v1

latestOpenAPI 3.0.02026-07-14235231.7 KB
user

Create a user

Note: Users must be created with an admin JWT.

post/users

Request body

display_namestring

A string to be displayed as user name. It does not need to be unique

image_urlstring url

A link to an image for conversations' and users' avatars

namestring

Unique name for a user

Example request

{
  "display_name": "My User Name",
  "image_url": "https://example.com/image.png",
  "name": "my_user_name"
}

Response

Create a user response

hrefstring url

A link towards a user included in Conversation API

idstring

User ID

Example response

{
  "href": "https://api.nexmo.com/v0.1/users/USR-63f61863-4a51-4f6b-86e1-46edebio0391",
  "id": "USR-63f61863-4a51-4f6b-86e1-46edebio0391"
}