Skip to main content
POST
Move WhatsApp conversation between responders

Authorizations

Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

org_id
string
required

The ID of the org

connection_id
string
required

The ID of the connection

phone_number_id
string
required

The ID of the WhatsApp phone number

Body

action
enum<string>
required

pass hands the conversation to another role, take claims it (escalation partner only), release hands it back to the entry point owner.

Available options:
pass,
take,
release
to
string

The customer phone number or WhatsApp ID.

Maximum string length: 32
recipient
string

The customer business-scoped user ID, instead of to.

Maximum string length: 128
control_pass
object

Where a pass goes. Without it the conversation goes to the escalation partner.

metadata
string

Free text Meta forwards to the new owner in the handover.

Maximum string length: 2000

Response

200 - application/json
messaging_product
string
required
request_id
string
required