Skip to main content
POST
Validate an SMS or WhatsApp survey delivery

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
survey
string<uuid>
required

Body

application/json
channel
enum<string>
required
Available options:
sms,
whatsapp
recipient
string
required
Pattern: ^\+[1-9][0-9]{7,14}$
locale
string
default:en
template_reference
string

Required for WhatsApp Business delivery.

message
string
Maximum string length: 1000
scheduled_at
string<date-time>

Response

Successful data envelope.

data
any
required
meta
object
required