Get Subscription Redirect URL

Tool name: get-opt-in-process-redirect-url

Returns the URL one contact is redirected to by an opt-in process. The contact's email address is required and is what the answer is about: the URL carries that contact's own id, address and subscriber key, so an address nobody named produces a URL about the wrong person. Which page comes back follows the contact's state, reported as redirectPage: while the double opt-in confirmation is still open it is the pending page, and only a confirmed contact gets the thank-you page -- a pending answer means that contact has not confirmed yet, not that the process is misconfigured. The URL also carries the page's campaign tracking. Processes without a custom page fall back to the KlickTipp-hosted pending or thank-you page.

Input schema

emailstring, [ 3 .. 250 ] charactersrequired

Email address of the contact the URL is resolved for; required, and it identifies which contact the URL points at

optInProcessIdnull or integer, >= 1

Opt-in process to resolve for; omit for the one the subscriber signed up through

Default:null

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "email": "string",
  "optInProcessId": null,
  "accountId": null
}

Output schema

accountIdintegerrequired

subscriberIdintegerrequired

emailstringrequired

subscriptionStatusstringrequired

optInProcessIdintegerrequired

optInProcessNamestringrequired

redirectUrlstringrequired

redirectPagestringrequired

Output example

{
  "accountId": 0,
  "subscriberId": 0,
  "email": "string",
  "subscriptionStatus": "string",
  "optInProcessId": 0,
  "optInProcessName": "string",
  "redirectUrl": "string",
  "redirectPage": "string"
}