Pass or release WhatsApp thread control (WAME)

post

https://partner.gupshup.io/partner/bizgate/app/{appId}/thread/control

Passthrough to Self Serve thread control (WASS forwards the JSON to Meta thread_control).

Request parameters

Path parameters

Key	Description	Values	Data Type	Required/Optional
appId	Identifier of the WhatsApp app the call acts on.	6f414190-d45c-4671-bca1-fb6c3018cb13	String	Required

Body

Key	Description	Values	Data Type	Required/Optional
messaging_product	Must be whatsapp.	whatsapp	—	Required
to	Destination WhatsApp user phone number (the conversation to pass or release).	16XXXXXXX34	—	Required
action	pass hands the thread to another app on the WhatsApp account; release returns control to the primary app. Any other action Meta accepts on thread_control is also forwarded as-is.	release	—	Required

Sample cURL — Pass or release WhatsApp thread control (WAME).

curl --request POST \
  --url 'https://partner.gupshup.io/partner/bizgate/app/6f414190-d45c-4671-bca1-fb6c3018cb13/thread/control' \
  --header 'Authorization: Bearer <UT>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "messaging_product" : "whatsapp",
  "to" : "16XXXXXXX34",
  "action" : "release"
}'

Sample success response (200)

{
  "success": true
}

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Responses

Language

Credentials

Bearer

Universal Token (UT)

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request - the app has no API key (PP-ERR-AUTH-010); Self Serve / Meta rejected the request (PP-ERR-API-005: their message, their status, and any further error fields as JSON in details); or Self Serve was unavailable - it answered 502/503/504 (PP-ERR-API-003, answered 400)

401Unauthorized — missing, expired, or invalid bearer token

403Forbidden — authenticated but not permitted for this resource

429Rate limit exceeded for this endpoint

500Internal Server Error - Self Serve answered a 5xx other than 502/503/504 (PP-ERR-API-005, Self Serve's status), returned no response (PP-ERR-APP-027), or an unexpected failure (PP-ERR-API-002)