Skip to content

Delete Opt-In Process

Tool name: delete-opt-in-process

Deletes an opt-in process and its confirmation email permanently; existing contacts keep their subscriptions. Refuses the default process or one still referenced by forms, campaigns or other entities, naming dependencies. Requires the user to request deletion of this process ID.

Input schema

optInProcessIdinteger, >= 1required

ID of the opt-in process to delete

accountIdnull or integer, >= 1

User ID of the account; omit for the account the access token works in

Default:null
Input example
{ "optInProcessId": 1, "accountId": null }

Output schema

accountIdintegerrequired
idintegerrequired
namestringrequired
Output example
{ "accountId": 0, "id": 0, "name": "string" }