POST
/
v2
/
unsubscribe
Unsubscribe from Alerts
curl --request POST \
  --url https://alerts-api.dial.to/v2/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Dialect-Client-Key: <x-dialect-client-key>' \
  --data '{
  "appId": "123e4567-e89b-12d3-a456-426614174000",
  "channel": "IN_APP"
}'
{}

Authorizations

​
Authorization
string
header
required

Bearer token authentication for subscriber calls

Headers

​
X-Dialect-Client-Key
string
required

Client Key used to uniquely identify the client

Example:

"dk_gyh2eqzfkc4mhp5eiahnndkz"

Body

application/json
​
appId

App ID or an array of App IDs. If empty or omitted, targets all apps available (owned or whitelisted) for the client. Application ID

Example:

"255d6163-7e25-43e9-a188-c2f8d0980a4a"

​
channel

Channel or an array of channels (IN_APP, TELEGRAM, EMAIL). If empty or omitted, targets all channels available for the subscriber

Available options:
IN_APP,
EMAIL,
TELEGRAM
Example:

"IN_APP"

Response

Unsubscription successful

The response is of type object.