Search Opt-In Processes

Tool name: search-opt-in-processes

Searches the active KlickTipp opt-in processes (also called subscription processes or subscriber lists) of an account, sorted by name, with ID, name, opt-in mode and the flags that tell them apart. Deleted processes are left out. Lists the account the access token belongs to, or one of its subaccounts when an account ID is given. The full configuration of a single entry is get-opt-in-process.

Input schema

querynull or string, <= 250 characters

Case-insensitive name fragment to search for; omit to return every active process

Default:null

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "query": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

countintegerrequired

optInProcessesArray of objectsrequired

Output example

{
  "accountId": 0,
  "count": 0,
  "optInProcesses": [
    {
      "id": 0,
      "name": "string",
      "isDefaultProcess": true,
      "optInMode": "string",
      "resendConfirmationEmail": true,
      "useForChangeEmail": true,
      "createdAt": "string",
      "confirmationEmailId": 0,
      "editUrl": "string"
    }
  ]
}