Send a test email

Overview

Send an email type to your own address.

Use this to see it in a real inbox.

You'll need the type. The test goes to the email address of the user behind the token.

The email is sent, with [Test] added to the front of the subject. Content you send is used for this test only and isn't saved; anything you leave out comes from the saved template. Merge fields are filled with their sample values.

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.
• An email address on your user.

Base URL

Endpoint

POST /api/v1/account/white-label/email-templates/send-test

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.).
• The test always goes to your own email address; if your user has none you get 400.

Rate limit

60 requests per minute, counted per user (the token’s user). See Rate limits.

Request parameters

None.

Request body

The test always goes to your own email address, with [Test] added to the front of the subject. 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+",
  "show_logo": true
}

Response body

The payload is inside data.

Response payload

{
  "data": {
    "status": "success",
    "message": "Test email sent to [email protected]"
  }
}

Examples

Success payload

See Response payload.

Error payload

400 Your user has no email address

{
  "message": "Your account has no email address to send a test to.",
  "status": "error",
  "errors": []
}

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."
    ]
  }
}

429 Too many requests

{
  "message": "Too Many Attempts."
}

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/send-test" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5994, "type": "user_welcome", "body": "PHA+SGVsbG8gW2N1c3RvbWVyTmFtZV08L3A+", "show_logo": true}'