Create Unsubscription Process

Tool name: create-unsubscription-process

Creates an unsubscription dialog (message) or redirect (URL) with existing manual tags as matching tags. Requires administrator access; dialog limits and redirect entitlement apply. Affects future unsubscription journeys but unsubscribes nobody now; requires the user’s request.

Input schema

kindstringrequired

Enum:"dialog""redirect"

namestring, [ 1 .. 250 ] charactersrequired

tagIdsArray of integersrequired

Existing manual tags of the account selecting this dialog or redirect; a repeated ID is stored once

messagenull or string, <= 150 characters

Default:null

urlnull or string, <= 800 characters

Default:null

accountIdnull or integer, >= 1

Default:null

Input example

{
  "kind": "dialog",
  "name": "string",
  "tagIds": [
    1
  ],
  "message": null,
  "url": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

kindstringrequired

Enum:"dialog""redirect"

idintegerrequired

namestringrequired

messagestring or nullrequired

urlstring or nullrequired

tagIdsArray of integersrequired

weightintegerrequired

editUrlstringrequired

Output example

{
  "accountId": 0,
  "kind": "dialog",
  "id": 0,
  "name": "string",
  "message": "string",
  "url": "string",
  "tagIds": [
    0
  ],
  "weight": 0,
  "editUrl": "string"
}