Skip to main content
POST
Start a channel connection.

Authorizations

x-api-key
string
header
required

Your agency API key (dmly_ag_…). It authenticates the acting agency and scopes every request to that agency's own sub-accounts and plans.

Headers

Idempotency-Key
string

Makes a retry return the same session.

Maximum string length: 200

Path Parameters

workspace
string<uuid>
required

Workspace id.

Body

application/json
platform
enum<string>
required
Available options:
whatsapp,
facebook,
instagram
return_url
string<uri>
required
state
string

Your correlation value. No secrets or personal data.

Maximum string length: 500
channel_id
string<uuid>

An existing channel on this sub-account to reconnect.

Response

An Idempotency-Key replay: the existing session.