Get Opt-In Process

Tool name: get-opt-in-process

Returns the configuration of a single KlickTipp opt-in process (also called subscription process or subscriber list), looked up by its numeric ID: name, opt-in mode, confirmation email ID, redirect URLs with their query and UTM parameters, pending subscriber deletion, labels and notes. Reads from the account the access token belongs to, or from one of its subaccounts when an account ID is given.

Input schema

optInProcessIdinteger, >= 1required

ID of the opt-in process, as shown in the KlickTipp app URL

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

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"
}