API referenceContacts
Set or clear Opted out for a Channel
Opted out is a hard gate per Contact per Channel. Setting opted_out true records the opt-out; false clears it (opt-in). Only push is supported in V1.
PUT
Opted out is a hard gate per Contact per Channel. Setting opted_out true records the opt-out; false clears it (opt-in). Only push is supported in V1.
bearerAuthheader
AuthorizationBearer <API key>Project API key (cr_sk_...)
external_user_id*stringchannel*"push"Value in
"push"application/json- body
opted_out*booleanUpdated
application/json- response
contact_id?stringFormat
uuidexternal_user_id?stringchannel*"push"Value in
"push"opted_out*booleancurl -X PUT 'https://api.comraid.io/contacts/string/opt-outs/push' \ -H 'Content-Type: application/json' \ -d '{ "opted_out": true}'Example Response
{ "contact_id": "f245e2a3-e141-4d41-912c-b1c1f5bd5598", "external_user_id": "string", "channel": "push", "opted_out": true}