Set conversation status
Sets the status of a conversation to open, pending or closed. The assignee is kept.
Base URL:
PATCH: https://api.smsgatewayapi.com/v1/conversations/{key}/statusExample:
PATCH: https://api.smsgatewayapi.com/v1/conversations/32470123456/status
| Parameter | Input | Description | |
|---|---|---|---|
| client_id | API client ID | Developer › API & Webhooks › API credentials | Required |
| client_secret | API client secret | A cs_ credential, shown once when you create it under Developer › API & Webhooks › API credentials | Required |
| key | conversation key | The conversation as shown in your conversation list: a phone number in international format (e.g. 32470123456), a WhatsApp user ID for a user without phone number (BE.… for WhatsApp Business, WA.LID… for WhatsApp Web) or group:gid_… for a group conversation (the numeric group ID is accepted too). Group keys are always returned with the public group ID. | Required |
| status | open, pending or closed | The new status of the conversation | Required |
<?php
//PHP - cURL
$ch = curl_init();
$url = "https://api.smsgatewayapi.com/v1/conversations/{key}/status";
$client_id = "XXX"; // Your API client ID (required)
$client_secret = "YYY"; // Your API client secret (required)
$data = [
'status' => "pending" //open, pending or closed (required)
];
curl_setopt($ch, CURLOPT_URL, "$url");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_VERBOSE, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"X-Client-Id: $client_id",
"X-Client-Secret: $client_secret",
"Content-Type: application/json",
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
$response = curl_exec($ch);
?>
Example request:
{
"status": "pending"
}
Example success response:
{
"conversation_key": "BE.13491208655302741918",
"assignee": {
"public_id": "sub_3520a1ec234dbabe1232def67e858855",
"name": "alice"
},
"status": "pending",
"assigned_at": "2026-09-07 10:15:00"
}
Example error response:
{
"error": 144,
"errorMsg": "Invalid conversation status [done]; use open, pending or closed"
}
