/opt/out/wa and /opt/in/wa.
string
required
API key generated for the TUC associated with the sending phone number. Required on
every request below.
Get Opt Out
Lists numbers currently opted out.Sample cURL request
Get Opt In
Lists numbers currently opted in.Sample cURL request
Add Opt Out
Adds one or more numbers to the opt-out list for the given message type(s).array
required
Array of recipient phone numbers to opt out.
string
required
Sender’s registered WhatsApp number.
array
required
Message categories to opt out of. Values:
marketing, utility.Sample JSON payload
Sample cURL request
Add Opt In
Adds one or more numbers to the opt-in list for the given message type(s).array
required
Array of recipient phone numbers to opt in.
string
required
Sender’s registered WhatsApp number.
array
required
Message categories to opt into. Values:
marketing, utility.Sample JSON payload
Sample cURL request
Remove Opt Out
Removes a number from the opt-out list for a given message type.Query parameters
string
required
Recipient phone number to remove from the opt-out list.
string
required
Sender’s registered WhatsApp number.
string
required
Message category to remove the opt-out for. Values:
marketing, utility.Sample cURL request
Remove Opt In
Removes a number from the opt-in list for a given message type.Query parameters
string
required
Recipient phone number to remove from the opt-in list.
string
required
Sender’s registered WhatsApp number.
string
required
Message category to remove the opt-in for. Values:
marketing, utility.