Sign in

v1

latestOpenAPI 3.0.02026-07-14235231.7 KB
conversation

Update a conversation

put/conversations/{conversation_id}

Request body

display_namestring

The display name for the conversation. It does not have to be unique

image_urlstring url

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

namestring

Unique name for a conversation

Example request

{
  "display_name": "Customer Chat",
  "image_url": "https://example.com/image.png",
  "name": "customer_chat",
  "properties": {
    "ttl": 60
  }
}

Response

Create / Update Conversation Response Payload Object

hrefstring url required

A link towards a conversation included in Conversation API

idstring required

The unique identifier for this conversation

Example response

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