Get template variables for a type

Overview

Returns the list of supported variable tokens (with sample values) usable in the header/body/footer/signature content for one template type.

Prerequisites

A bearer token. Callable with Partner and Account tokens.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

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

Authentication

Requires a bearer token in the Authorization: Bearer <bearer-token> header.
Who can call it: Partner and Account tokens.
Authentication plus an email-template feature check.
company_id is scoped by an ownership check validation rule.
Same scope rule for both roles. A partner can address any descendant company. An account only itself and its descendants.

Rate limit

No rate limit.

Request body

Body:

Field	Type	Required	Description
`company_id`	integer	Yes	Must be an existing account inside your own account tree.
`type`	string	Yes	Must be a valid `EmailTemplateType` value.

{
  "company_id": 1,
  "type": "verify_email"
}

Response

data.status (string) — success.
data.data[] (array) — each item:
name (string) — display name, e.g. Recipient Name.
token (string) — bracketed token to insert, e.g. [recipientName].
description (string) — what the token resolves to.
sample (string) — sample value used in preview/test.
scope (string) — token scope, e.g. recipient, review, location, account, global.

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": [
      {
        "name": "Recipient Name",
        "token": "[recipientName]",
        "description": "First name of the alert recipient.",
        "sample": "Jane",
        "scope": "recipient"
      },
      {
        "name": "Partner Title",
        "token": "[partnerTitle]",
        "description": "White-label product title shown in emails.",
        "sample": "Acme Reviews",
        "scope": "account"
      },
      {
        "name": "Primary Color",
        "token": "[primaryColor]",
        "description": "Partner brand color from theme settings.",
        "sample": "#1459c4",
        "scope": "account"
      },
      {
        "name": "Current Year",
        "token": "[currentYear]",
        "description": "The current four-digit year.",
        "sample": "2026",
        "scope": "global"
      },
      {
        "name": "Unsubscribe URL",
        "token": "[unsubscribeUrl]",
        "description": "Link the recipient can use to unsubscribe.",
        "sample": "https://app.example.com/unsubscribe/abc123",
        "scope": "recipient"
      }
    ]
  }
}

422 Validation Error · `422`

{
  "message": "The selected type is invalid.",
  "errors": {
    "type": [
      "The selected type is invalid."
    ]
  }
}

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`422`	Validation Error
`500`	Unexpected server error

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/variables" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 1, "type": "verify_email"}'

Updated 10 days ago

Did this page help you?