Skip to content

Update Unsubscription Process

Tool name: update-unsubscription-process

Updates supplied unsubscription dialog or redirect settings; omitted values stay, weight sets display order and kind cannot change. Affects future unsubscription journeys only.

Input schema

kindstringrequired
Enum:"dialog""redirect"
idinteger, >= 1required
namenull or string, [ 1 .. 250 ] characters
Default:null
tagIdsArray of integers or null

Omit to preserve matching tags; supplied manual tag IDs replace them, a repeated ID is stored once

Default:null
messagenull or string, <= 150 characters
Default:null
urlnull or string, <= 800 characters
Default:null
weightnull or integer, >= 0
Default:null
accountIdnull or integer, >= 1
Default:null
Input example
{ "kind": "dialog", "id": 1, "name": null, "tagIds": null, "message": null, "url": null, "weight": 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" }