Save an email template

Overview

Save your custom version of an email type.

Use this after editing.

You'll need the type and the content.

The override is saved and used from now on.

Prerequisites

• A bearer token. See Authentication.
• The account's id (company_id), with the email templates section turned on.
• The email type, from List email types.

Base URL

Endpoint

POST /api/v1/account/white-label/email-templates/save

Authentication

Partner or Account token

• company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
• An account outside your tree, or one that doesn't exist, is rejected with 422.
• The email templates section must be turned on for the account's partner (email_templates_enabled in Get branding). When it's off, every email template call for that account returns 403 with The email template section is disabled for this account.
• Types managed centrally by the platform return 403 (This template is managed centrally and cannot be edited here.).

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

A save replaces all four regions: any of header, body, footer or signature you leave out is reset to the default, so send every region you want to keep. subject_override left out is cleared too. template_mode and custom_html are kept when you leave them out.

Region fields are base64-encoded HTML.

Only the merge fields returned by List an email's merge fields for that type are accepted (the example decodes to <p>Hello [customerName]</p>, valid for user_welcome); any other token returns 422 Unknown variables for this template: [token].

Request payload

{
  "company_id": 5994,
  "type": "user_welcome",
  "body": "PHA+SGVsbG8gW2N1c3RvbWVyTmFtZV08L3A+",
  "subject_override": "Welcome to [partnerTitle]!",
  "template_mode": "regions"
}

Response body

The payload is inside data.

Response payload

{
  "data": {
    "status": "success",
    "message": "Email template saved successfully."
  }
}

Examples

Success payload

See Response payload.

Error payload

403 Email templates section is off

{
  "message": "The email template section is disabled for this account.",
  "status": "error",
  "errors": []
}

403 Type managed centrally

{
  "message": "This template is managed centrally and cannot be edited here.",
  "status": "error",
  "errors": []
}

422 Unknown merge field

{
  "message": "Unknown variables for this template: [recipientName]",
  "errors": {
    "body": [
      "Unknown variables for this template: [recipientName]"
    ]
  }
}

422 template_mode isn't allowed

{
  "message": "The selected template mode is invalid.",
  "errors": {
    "template_mode": [
      "The selected template mode is invalid."
    ]
  }
}

422 Account outside your tree

{
  "message": "The selected company id does not belong to your company hierarchy.",
  "errors": {
    "company_id": [
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/save" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994, "type": "user_welcome", "body": "PHA+SGVsbG8gW2N1c3RvbWVyTmFtZV08L3A+", "subject_override": "Welcome to [partnerTitle]!", "template_mode": "regions"}'