Update Opt-In Confirmation Email Content

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

Replaces the body of the confirmation email a double opt-in process sends. html and plain are each written whole, not patched, and a part that is not given keeps its text -- so writing only one leaves the email saying two different things to two recipients. Write both. The platform checks the result the way the editor does: errors, such as a missing unsubscribe link or an empty subject, stop the write and are returned in validationMessages with stored false; warnings do not. This email is the legal record of a contact's consent in many countries -- it must still say who is subscribing them to what. Change it only when the user asked for it, and say what changed.

Input schema

optInProcessIdinteger, >= 1required

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

htmlnull or string, <= 500000 characters

Complete HTML body; replaces the current one, empty string makes the email plain-text only

Default:null

plainnull or string, <= 500000 characters

Complete plain-text body; replaces the current one

Default:null

subjectnull or string, [ 1 .. 150 ] characters

Subject line

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,
  "html": null,
  "plain": null,
  "subject": null,
  "accountId": null
}

Output schema

emailIdintegerrequired

optInProcessIdintegerrequired

subjectstringrequired

contentTypestringrequired

Enum:"plain""html-and-plain"

htmlstringrequired

plainstringrequired

validationMessagesArray of objectsrequired

storedbooleanrequired

editUrlstringrequired

Output example

{
  "emailId": 0,
  "optInProcessId": 0,
  "subject": "string",
  "contentType": "plain",
  "html": "string",
  "plain": "string",
  "validationMessages": [
    {
      "type": "error",
      "code": "string",
      "message": "string"
    }
  ],
  "stored": true,
  "editUrl": "string"
}