Update Conversation - Early Access

Resource

https://api.infobip.com/ccaas/1/conversations/{conversationId}

Parameters

Use this method to update the Conversation properties.

Path Params

Property name	Type	Description
*conversationId	string	Required - Conversation id to be updated

Body Params

Property name	Type	Description
topic	string	The topic of conversation can be any text up to 255 characters.
summary	string	Short description of conversation can be any text up to 4000 characters.
*status	string	Required - Conversation status (OPEN, WAITING, SOLVED, CLOSED).
priority	string	Conversation priority (URGENT, HIGH, NORMAL, LOW)
queueId	string	Queue identification conversation belongs to
agentId	string	Agent identifier assigned to the conversation
channel	string	Communication channel (SMS, VIBER, FACEBOOK_MESSENGER, WHATSAPP, UNKNOWN, MULTICHANNEL, NO_CHANNEL).

Request Example

JSON

					PUT /ccaas/1/conversations/573711510E1C002E29679B12C7CB48AE HTTP/1.1
Host: api.infobip.com
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Accept: application/json

{
    "topic": "Updated topic",
    "summary": "Summary demo",
    "status": "WAITING",
    "priority": "NORMAL",
    "queueId": "FBDDA7F8B33417374ACC02F5265527E6",
    "agentId": "6298AA7707903A4ED680B436929681AD"
}

Response

					{
    "id": "573711510E1C002E29679B12C7CB48AE",
    "topic": "Updated topic",
    "summary": "Summary demo",
    "status": "WAITING",
    "priority": "NORMAL",
    "queueId": "FBDDA7F8B33417374ACC02F5265527E6",
    "agentId": "6298AA7707903A4ED680B436929681AD",
  	"createdAt": "2019-04-24T11:25:41.058+0000",
    "updatedAt": "2019-04-27T10:20:40.050+0000",
    "channel": "SMS"
}

					{
  "statusCode": "ERROR",
  "message": "Invalid id '573711510E1C002E29679B12C7CB48AE' given! No such entity exists."
}

					{
    "statusCode": "ERROR",
    "message": "Required request body is missing or not valid"
}

Closed conversations

Conversations with status CLOSED can’t be updated, except topic and summary.

Additional example

Conversations with status "CLOSED" have additional information about timestamp when conversation was closed.

JSON

PUT /ccaas/1/conversations/573711510E1C002E29679B12C7CB48AE HTTP/1.1
Host: {base_url}
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Accept: application/json

{
    "topic": "Updated topic",
    "summary": "Summary demo",
    "status": "CLOSED",
    "priority": "NORMAL",
    "queueId": "FBDDA7F8B33417374ACC02F5265527E6",
    "agentId": "6298AA7707903A4ED680B436929681AD"
}

Response

JSON

{
    "id": "573711510E1C002E29679B12C7CB48AE",
    "topic": "Updated topic",
    "summary": "Summary demo",
    "status": "CLOSED",
    "priority": "NORMAL",
    "queueId": "FBDDA7F8B33417374ACC02F5265527E6",
    "agentId": "6298AA7707903A4ED680B436929681AD",
    "createdAt": "2019-04-24T11:25:41.058+0000",
    "updatedAt": "2019-04-28T10:21:41.050+0000",
    "closedAt": "2019-04-28T10:21:41.050+0000",
    "channel": "SMS"
}