Opt a customer email out of outbound notifications

POST/support/unsubscribe

Request body

application/json

organizationIdstringrequired

emailstring<email>required

Responses

200

Opt-out recorded

okbooleanrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Bodyapplication/json

organizationIdstring*emailstring*

Request

curl -X POST '/support/unsubscribe' \
  -H 'Content-Type: application/json' \
  -d '{
  "organizationId": "string",
  "email": "user@example.com"
}'

const response = await fetch("/support/unsubscribe", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"organizationId\": \"string\",\n  \"email\": \"user@example.com\"\n}"
});

import requests

response = requests.post(
    "/support/unsubscribe",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"organizationId\": \"string\",\n  \"email\": \"user@example.com\"\n}",
)

Response

{
  "ok": true
}