Skip to main content
POST
Create a setup link

Authorizations

Authorization
string
header
required

Your API key, e.g. sk_live_... or sk_test_....

Headers

Idempotency-Key
string

Optional. Makes this write safe to retry: the same key replays the first response instead of acting twice.

Maximum string length: 255

Body

application/json
customer_id
string
required

Customer public id.

expires_in_days
integer
Required range: 1 <= x <= 90
use_policy
enum<string>
Available options:
single,
multi
max_uses
integer
Required range: 1 <= x <= 1000
allowed_connection_type
enum<string>
Available options:
new,
reconnect,
either
redirect_url
string

Where to send them afterwards.

Maximum string length: 2048
locale
string
Maximum string length: 16
success_webhook_url
string
Maximum string length: 2048
failure_webhook_url
string
Maximum string length: 2048
template_set
string

Starter templates to apply when the customer connects. Valid keys from GET /v1/templates/sets.

Response

Created.

id
string

Public id, prefixed set_.

customer_id
string
url
string

Hand this to the customer to connect WhatsApp.

expires_at
string<date-time> | null
use_policy
enum<string>
Available options:
single,
multi
use_count
integer
max_uses
integer | null
allowed_connection_type
enum<string>
Available options:
new,
reconnect,
either
redirect_url
string | null
revoked_at
string<date-time> | null
usable
boolean
token
string

Returned only on creation, inside url.