Skip to content
/
Update Opt-In Process

Update Opt-In Process

Tool name: update-opt-in-process

Changes the settings of one KlickTipp opt-in process (also called subscription process or subscriber list): name, opt-in mode, redirect URLs with their query and UTM parameters, confirmation resend, change-email role, deletion of unconfirmed contacts, labels and notes. Only the arguments that are given are written, the rest keeps its current value. Settings take effect for contacts subscribing from now on; contacts already in the process are not touched and nothing is sent. Single opt-in subscribes later contacts without confirming, which is not permitted everywhere - ask before setting it. The confirmation email is written with the opt-in confirmation email tools. A page parameter is a NAME the platform fills with contact data; a UTM parameter is a VALUE under a fixed name. Both reach a page only together with that page's URL in the same call. get-opt-in-process reads them.

Input schema

optInProcessIdinteger, >= 1required

ID of the opt-in process to change

namenull or string, [ 1 .. 250 ] characters

New name; omit to keep the current one

Default:null
notesnull or string, <= 2000 characters

Internal note, not visible to contacts; empty string clears it

Default:null
optInModenull or string

"double" for a confirmation email, "single" without one

Default:null
Enum:"double""single"
pendingRedirectUrlnull or string, <= 2000 characters

URL a contact reaches after subscribing, before confirming; empty string restores the KlickTipp page

Default:null
confirmedRedirectUrlnull or string, <= 2000 characters

URL a contact reaches after confirming; empty string restores the KlickTipp page

Default:null
resendConfirmationEmailnull or boolean

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

Default:null
useForChangeEmailnull or boolean

Whether this process handles email address changes; true takes that role away from the process that holds it

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

Complete list of labels; replaces the existing labels, empty array removes them all

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
accountIdnull or integer, >= 1

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

Default:null
Input example
{
  "optInProcessId": 1,
  "name": null,
  "notes": null,
  "optInMode": "double",
  "pendingRedirectUrl": null,
  "confirmedRedirectUrl": null,
  "resendConfirmationEmail": null,
  "useForChangeEmail": null,
  "deletePendingSubscribersAfterDays": 0,
  "metaLabels": null,
  "pendingPageParameters": null,
  "confirmedPageParameters": null,
  "pendingUtmParameters": null,
  "confirmedUtmParameters": 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"
}