Update conversation status

PATCH

/api/v1/conversations/{id}

Update the status of a conversation. Use this to close, reopen, or set a conversation to pending.

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Body Params application/jsonRequired

Example

{
  "status": "closed"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH '/api/v1/conversations/123' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "status": "closed"
}'

Responses

🟢200Success

application/json

Updated conversation

Body

Example

{
    "id": 0,
    "status": "open",
    "escalated": true,
    "can_respond_till": "2019-08-24T14:15:22.123Z",
    "subscriber": {
        "id": 0,
        "name": "string",
        "phone_number": "string"
    },
    "assigned_to": {
        "type": "string",
        "id": 0,
        "name": "string"
    },
    "last_activity_at": "2019-08-24T14:15:22.123Z",
    "updated_at": "2019-08-24T14:15:22.123Z",
    "created_at": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-04-21 12:14:00

List conversations

Agent Assignment