Send Opt-In Confirmation Email Test

Tool name: send-opt-in-confirmation-email-test

Sends the confirmation email of an opt-in process as a test to a single address, so its text can be read before a contact gets it -- the same send the test dialog of KlickTipp performs. Any address may receive one, and an address that is not a contact of the account yet becomes one and is tagged as a test recipient, which can start automations; name the address and say what it will become before calling this. The confirmation link in a test does not confirm anybody. Nothing about the opt-in process changes, and no contact of it is a recipient. Read the body first with get-opt-in-confirmation-email-content.

Input schema

optInProcessIdinteger, >= 1required

ID of the opt-in process whose confirmation email is sent

recipientEmailstring, [ 3 .. 250 ] charactersrequired

Address the test goes to; becomes a contact of the account if it is not one yet

accountIdnull or integer, >= 1

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

Default:null

Input example

{
  "optInProcessId": 1,
  "recipientEmail": "string",
  "accountId": null
}

Output schema

accountIdintegerrequired

optInProcessIdintegerrequired

emailIdintegerrequired

subjectstringrequired

recipientEmailstringrequired

messagesArray of stringsrequired

warningsArray of stringsrequired

Output example

{
  "accountId": 0,
  "optInProcessId": 0,
  "emailId": 0,
  "subject": "string",
  "recipientEmail": "string",
  "messages": [
    "string"
  ],
  "warnings": [
    "string"
  ]
}