Update Opt-In Confirmation Email

Tool name: update-opt-in-confirmation-email

Changes the settings of the confirmation email a double opt-in process sends: subject, sender name and address, reply-to, CC, BCC and sender domain. Only the arguments that are given are written, except that senderDomain may be normalized when account domain state changed. A sender address has to be configured and covered by a live verified domain. For an ordinary sender address, senderDomain is checked and derived when omitted; a dispatch profile keeps deciding both values itself. The body is not written here: that is update-opt-in-confirmation-email-content, and the block tools do not accept this email at all. This email is the legal record of a contact's consent in many countries: change its sender or subject only when the user asked for it, and say what was changed.

Input schema

optInProcessIdinteger, >= 1required

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

subjectnull or string, [ 1 .. 250 ] characters

Subject line of the confirmation email

Default:null

senderNamenull or string, [ 1 .. 250 ] characters

Name the email comes from

Default:null

senderEmailnull or string, <= 250 characters

Configured address the email comes from, or empty for the account's own address

Default:null

replyToEmailnull or string, <= 250 characters

Address a reply goes to; empty string returns it to the account's own address

Default:null

ccEmailnull or string, <= 250 characters

Address that receives a copy; empty string removes it

Default:null

bccEmailnull or string, <= 250 characters

Address that receives a blind copy; empty string removes it

Default:null

senderDomainnull or string, <= 250 characters

Domain the email is sent through; omit to derive it from the resulting sender address

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,
  "subject": null,
  "senderName": null,
  "senderEmail": null,
  "replyToEmail": null,
  "ccEmail": null,
  "bccEmail": null,
  "senderDomain": null,
  "accountId": null
}

Output schema

emailIdintegerrequired

optInProcessIdintegerrequired

subjectstringrequired

senderNamestringrequired

senderEmailstringrequired

replyToEmailstringrequired

ccEmailstringrequired

bccEmailstringrequired

senderDomainstringrequired

senderEmailOptionsArray of stringsrequired

senderDomainOptionsArray of stringsrequired

senderIdentityobjectrequired

bodyIsEditablebooleanrequired

editUrlstringrequired

Output example

{
  "emailId": 0,
  "optInProcessId": 0,
  "subject": "string",
  "senderName": "string",
  "senderEmail": "string",
  "replyToEmail": "string",
  "ccEmail": "string",
  "bccEmail": "string",
  "senderDomain": "string",
  "senderEmailOptions": [
    "string"
  ],
  "senderDomainOptions": [
    "string"
  ],
  "senderIdentity": {
    "effectiveSenderEmail": "string",
    "customerDomain": "string",
    "normalizedSenderDomain": "string",
    "status": "ready",
    "isUsable": true,
    "senderEmailOptions": [
      "string"
    ],
    "senderDomainOptions": [
      "string"
    ]
  },
  "bodyIsEditable": true,
  "editUrl": "string"
}