Opt-In Processes

Use these tools to create and manage the processes through which people subscribe to communications. Opt-in processes connect consent, subscription behavior, and the confirmation email that supports the signup experience.

For example, you can configure a new subscription process, update its confirmation email, preview the result, or send a test. Additional consent and subscription workflows may become available as the MCP server evolves.

MCP tools

Create Opt-In Process

Tool name: create-opt-in-process

Creates an opt-in process (subscriber list) and its confirmation email, without subscribing anyone or sending. Defaults to double opt-in; single opt-in skips confirmation and requires the user’s approval. copyFromOptInProcessId also copies the confirmation email text; supplied settings override the copy. A page parameter is a name the platform fills with contact data; a UTM parameter is a value under a fixed name; both require the redirect URL in the same call. The change-email role is set separately with update-opt-in-process. Returns both process and email IDs.

Input schema

namestring, [ 1 .. 250 ] charactersrequired

Name of the new process; must be free within the account

notesnull or string, <= 2000 characters

Internal note, not visible to contacts

Default:null

optInModenull or string

"double" for a confirmation email, "single" without one; defaults to double

Default:null

Enum:"double""single"

pendingRedirectUrlnull or string, <= 2000 characters

URL a contact reaches after subscribing, before confirming; omit for the KlickTipp page

Default:null

confirmedRedirectUrlnull or string, <= 2000 characters

URL a contact reaches after confirming; omit for the KlickTipp page

Default:null

resendConfirmationEmailnull or boolean

Whether an already pending contact receives the confirmation email again on a repeated subscription

Default:null

deletePendingSubscribersAfterDaysnull or integer

Days after which unconfirmed contacts are deleted, one of 0, 1, 3, 7, 14; 0 keeps them

Default:null

Enum:013714

metaLabelsArray of strings, <= 50 items

Labels of the new process

Default:null

pendingPageParametersobject

Query parameters appended to pendingRedirectUrl, by the name each is appended under; needs pendingRedirectUrl in the same call

Default:null

confirmedPageParametersobject

Query parameters appended to confirmedRedirectUrl, by the name each is appended under; needs confirmedRedirectUrl in the same call

Default:null

pendingUtmParametersobject

Campaign tracking values appended to pendingRedirectUrl, by query name; the value, not the name; needs pendingRedirectUrl in the same call

Default:null

confirmedUtmParametersobject

The same for confirmedRedirectUrl; needs confirmedRedirectUrl in the same call

Default:null

copyFromOptInProcessIdnull or integer, >= 1

Existing process to copy settings and confirmation email from; the arguments above still win

Default:null

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "name": "string",
  "notes": null,
  "optInMode": "double",
  "pendingRedirectUrl": null,
  "confirmedRedirectUrl": null,
  "resendConfirmationEmail": null,
  "deletePendingSubscribersAfterDays": 0,
  "metaLabels": null,
  "pendingPageParameters": null,
  "confirmedPageParameters": null,
  "pendingUtmParameters": null,
  "confirmedUtmParameters": null,
  "copyFromOptInProcessId": null,
  "accountId": null
}

Output schema

idintegerrequired

accountIdintegerrequired

namestringrequired

isDefaultProcessbooleanrequired

optInModestringrequired

createdAtstringrequired

confirmationEmailIdintegerrequired

resendConfirmationEmailbooleanrequired

useForChangeEmailbooleanrequired

deletePendingSubscribersAfterDaysintegerrequired

pendingRedirectUrlstringrequired

confirmedRedirectUrlstringrequired

metaLabelsArray of stringsrequired

notesstringrequired

pendingPageParametersobjectrequired

confirmedPageParametersobjectrequired

pendingUtmParametersobjectrequired

confirmedUtmParametersobjectrequired

editUrlstringrequired

Output example

{
  "id": 0,
  "accountId": 0,
  "name": "string",
  "isDefaultProcess": true,
  "optInMode": "string",
  "createdAt": "string",
  "confirmationEmailId": 0,
  "resendConfirmationEmail": true,
  "useForChangeEmail": true,
  "deletePendingSubscribersAfterDays": 0,
  "pendingRedirectUrl": "string",
  "confirmedRedirectUrl": "string",
  "metaLabels": [
    "string"
  ],
  "notes": "string",
  "pendingPageParameters": {
    "property1": "string",
    "property2": "string"
  },
  "confirmedPageParameters": {
    "property1": "string",
    "property2": "string"
  },
  "pendingUtmParameters": {
    "property1": "string",
    "property2": "string"
  },
  "confirmedUtmParameters": {
    "property1": "string",
    "property2": "string"
  },
  "editUrl": "string"
}