PATCH
/
api
/
subscriptions
/
{id}
[DEPRECATED] Please use Partner Resource /api/resources/{schemaDefinitionNameOrId}/{externalId} instead
curl --request PATCH \
  --url https://api.embedreach.com/api/subscriptions/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "emailOptOut": true,
  "phoneOptOut": true
}'
{
  "success": true,
  "message": "<string>",
  "data": {
    "emailOptOut": true,
    "phoneOptOut": true
  }
}

Headers

​
reach-tenant-id
string

If using a platform scoped JWT, you can pass in a header to impersonate a specific tenant to impersonate the request as.

Body

application/json
​
emailOptOut
boolean

Whether the user has opted out of email

​
phoneOptOut
boolean

Whether the user has opted out of phone

Response

Status 200 response

​
success
boolean
required
​
message
string
​
data
object