Skip to main content
POST
Send a catalog 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
to
string
required

E.164 phone number, e.g. +919812345670.

Maximum string length: 32
body
string | null

An optional line before the link.

Maximum string length: 1000
phone_number_id
string | null
Maximum string length: 64
connection_uuid
string | null
Maximum string length: 64
idempotency_key
string | null
Maximum string length: 128
metadata
object

Response

Sent.

uuid
string
request_id
string | null
status
string
type
string
Example:

"text"

body
string

The text sent, including the catalog link.

provider_message_id
string | null
error_message
string | null