Patch conversation
Use this method to patch a conversation. Closed conversations cannot be changed. To change an assignment to another agent or a bot, use Change conversation assignment.More info
Please log in to see full path URL. Learn why.
patch
/ccaas/1/conversations/{conversationId}
Authorizations:
Scopes:
path Parameters
conversationId required | string Id of the conversation being patched. |
Request Body schema:
application/jsoncollapse all -
topic | string [ 0 .. 1000 ] characters Conversation topic. |
summary | string [ 0 .. 4000 ] characters Short description of the conversation. |
status | string Enum: "OPEN" "WAITING" "SOLVED" "CLOSED" Conversation status. |
priority | string Default: "NORMAL" Enum: "URGENT" "HIGH" "NORMAL" "LOW" Conversation priority. |
queueId | string [ 0 .. 255 ] characters Id of the queue conversation belongs to. |
agentId | string [ 0 .. 255 ] characters Id of the agent assigned to the conversation. |
Responses
200
OK
400
Bad request
401
Unauthorized
403
Forbidden
404
Not Found
500
Internal Server Error
Request samples
- Payload
- cURL
- Java
- C#
- Go
- Python
- PHP
- JavaScript
- NodeJs
- Ruby
Content type
application/json
Copy
Collapse all {- "topic": "Topic",
- "summary": "Summary",
- "status": "OPEN",
- "priority": "HIGH",
- "queueId": "6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
- "agentId": "c856e230-a8cd-498b-9996-42bbed35029a"
}
Response samples
- 200
- 400
- 401
- 403
- 404
- 500
Content type
application/json
Successful response
Copy
Collapse all {- "id": "1ddece93-041f-42ac-8e25-d05801dfe358",
- "topic": "Conversation topic",
- "summary": "Conversation summary",
- "status": "OPEN",
- "priority": "HIGH",
- "queueId": "6f2e6c5a-e4ca-48c6-bc0a-d9c18479743a",
- "agentId": "c856e230-a8cd-498b-9996-42bbed35029a",
- "createdAt": "2024-01-01T00:00:00.000+00:00",
- "updatedAt": "2024-01-01T00:00:00.000+00:00"
}
Need assistance
Encountering issues
What's new? Check out
Unsure about a term? See