Skip to main content
POST
cURL

Authorizations

Personal access token from Pingmee Settings → Developer Tools

x-api-key
string
header
required

Business API key from Pingmee Settings → Developer Tools

Path Parameters

id
string
required

Conversation participants identifiers (participantsIdentifiers). Must be URL-encoded when used in the path (for example, encode # as %23).

Body

application/json

Set the status of a conversation.

participantsIdentifiers
string
required

Unique identifiers of the conversation participants. Must match the URL path id (before URL encoding).

status
enum<string>
required

Conversation status.

Available options:
open,
closed,
standby
phoneNumberId
string

Business phone number ID. Required for Green API and web chat status notifications.

platform
enum<string>

Messaging platform. Used for platform-specific status handling.

Available options:
whatsapp,
greenAPI,
web,
instagram,
facebookMessenger
initiator
enum<string>

Who initiated the status change. Defaults to person when omitted.

Available options:
person,
bot,
campaign,
ai

Response

Conversation status updated successfully

The response is of type string.

Example:

"success"

Last modified on August 18, 2026