Skip to main content
PUT
Record a number's consent

Authorizations

Authorization
string
header
required

Your API key from the Wave dashboard. Sandbox keys start sk_sandbox_; production keys start sk_live_. Send as Authorization: Bearer <key>. Some endpoints require a production key and specific scopes.

Path Parameters

phone
string
required

The phone number, in any accepted form (+9665…, 9665… or 05…). URL-encode the +.

Example:

"+966501234567"

Body

application/json
status
enum<string>
required
Available options:
opted_out,
opted_in
evidence
string
Required string length: 1 - 1000

Response

The consent is recorded

id
string<uuid>
phone
string

The number in E.164.

Example:

"+966501234567"

status
enum<string>
Available options:
opted_out,
opted_in
source
enum<string>

keyword = the end user's STOP / START reply; api = this API; contact = the contact opt-out toggle.

Available options:
keyword,
api,
contact
evidence
string | null
changed_at
string<date-time>