ComRaidComRaid Docs
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
/contacts/{external_user_id}/opt-outs/{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.

Authorization

bearerAuth
headerAuthorizationBearer <API key>

Project API key (cr_sk_...)

Path Parameters

external_user_id*string
channel*"push"
Value in"push"

Request Body

application/json
  1. body
opted_out*boolean

Response Body

Updated

application/json
  1. response
contact_id?string
Formatuuid
external_user_id?string
channel*"push"
Value in"push"
opted_out*boolean
Example Request
curl -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}