Skip to main content
POST
Queue a consented review request

Authorizations

Authorization
string
header
required

A Contact Button scoped bearer key. Send Authorization: Bearer <token>. Token abilities are enforced independently of workspace membership; both checks must pass. OAuth 2.0 authorization-code flows are not currently available.

Headers

Idempotency-Key
string

Stable 8–120 character key for safe mutation retries.

Required string length: 8 - 120

Path Parameters

workspace
string<uuid>
required

Body

application/json
contact_id
string<uuid>
required
destination_id
string<uuid>
required
channel
enum<string>
required
Available options:
email,
sms,
whatsapp
message
string | null

Invitation copy supporting {contact}, {business}, and {review_link} tokens.

Maximum string length: 1400
template_id
string<uuid> | null

Required for WhatsApp and must identify an approved template on this workspace's connected Meta account.

template_parameters
(string | null)[]
Maximum array length: 10
Maximum string length: 1024
scheduled_at
string<date-time> | null
Maximum string length: 255

Response

Successful data envelope.

data
any
required
meta
object
required