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}/status

Example:

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);
?>

//NodeJs - HTTP request			
const https = require("https");
const client_id = "XXX"; // Your API client ID (required)
const client_secret = "YYY"; // Your API client secret (required)
const data = JSON.stringify({
	status: 'pending', //open, pending or closed (required)


});
const options = {
    hostname: "api.smsgatewayapi.com",
    port: 443,
    path: "/v1/conversations/{key}/status",
    method: "PATCH",
    headers: {
        "X-Client-Id": client_id,
        "X-Client-Secret": client_secret,
		"Content-Type": "application/json",
		"Content-Length": data.length,
    },
};
const req = https.request(options, (res) => {
    console.log(`statusCode: ${res.statusCode}`);
    res.on("data", (d) => {
        process.stdout.write(d);
    });
});
req.write(data);
req.end();

//Ruby - Net::HTTP			
require "uri"
require "net/http"

url = URI("https://api.smsgatewayapi.com/v1/conversations/{key}/status")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-Client-Id"] = "XXX" // Your API key
request["X-Client-Secret"] = "YYY" // Your API secret
request["Content-Type"] = "application/json"
form_data = [
	['status', "pending"] //open, pending or closed (required)


]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

//Python - Requests			
import requests
url = "https://api.smsgatewayapi.com/v1/conversations/{key}/status"
payload={
	'status' : 'pending' #open, pending or closed (required)
}
headers = {
	'X-Client-Id': 'XXX', #Your API key
	'X-Client-Secret': 'YYY', #Your API secret
	'Content-Type': 'application/json'
}
response = requests.request(
	"PATCH",
	url,
	headers=headers,
	json=payload
)
print(response.text)

//PowerShell - RestMethod
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("X-Client-Id", "XXX") // Your API key
$headers.Add("X-Client-Secret", "YYY") // Your API secret

$body = '{
	"status": "pending" //open, pending or closed (required)


}'

$response = Invoke-RestMethod 'https://api.smsgatewayapi.com/v1/conversations/{key}/status' -Method 'PATCH' -Headers $headers -Body $body -ContentType “application/json; charset=utf-8”
$response | ConvertTo-Json

//Shell - wget
wget --no-check-certificate --quiet \
  --method PATCH \
  --timeout=0 \
  --header 'X-Client-Id: XXX' \ // Your API key
  --header 'X-Client-Secret: YYY' \ // Your API secret
  --header 'Content-Type: application/json' \
  --body-data '{
	"status" : "pending" //open, pending or closed (required)


}' \
   'https://api.smsgatewayapi.com/v1/conversations/{key}/status'

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"
}

API

Guides

Messages

Voice

WhatsApp Business

Groups

Contacts

Outbox

Account

Sender IDs

Teammate/Subaccount

Conversations

Workflows

Message Templates

Birthday Message

Opt-out

Other

Webhooks (v2)

Set conversation status

SMS API

REGISTER NOW