Get a single template (editor payload)

Overview

Loads the full editor payload for one template type: raw override regions (null = inherit), resolved effective content, catalog defaults, theme color, and current settings (enabled, delivery method, logo visibility).

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/get

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.
Platform-owned types are forbidden (403) for any non-platform company.
Only the reachable companies differ per role, as above.

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	Valid `EmailTemplateType` value.

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

Response

data.status (string) — success.
data.data.type (string) — the template type value.
data.data.override (object) — raw stored override, all nullable: header, body, footer, signature (base64 or null), subject_override (plain string or null), custom_html (base64 or null).
data.data.template_mode (string) — regions or html.
data.data.resolved (object) — effective rendered regions: header, body, footer, signature (base64), subject (plain).
data.data.is_enabled (boolean), data.data.show_logo (boolean), data.data.delivery_method (string).
data.data.customized (boolean) — any content override present.
data.data.theme.primary_color (string) — partner account color.
data.defaults (object) — catalog defaults: header, body, footer, signature, custom_html (all base64) and subject (plain).

200 OK · `200`

{
  "data": {
    "status": "success",
    "data": {
      "type": "user_welcome",
      "override": {
        "header": null,
        "body": "PHA+SGkgdGhlcmUsPC9wPg==",
        "footer": null,
        "signature": null,
        "subject_override": "Welcome aboard, [recipientName]!",
        "custom_html": null
      },
      "template_mode": "regions",
      "resolved": {
        "header": "",
        "body": "PHA+SGkgdGhlcmUsPC9wPg==",
        "footer": "",
        "signature": "PHA+VGhhbmsgeW91LDxicj48c3Ryb25nPltwYXJ0bmVyVGl0bGVdPC9zdHJvbmc+PC9wPg==",
        "subject": "Welcome aboard, [recipientName]!"
      },
      "is_enabled": true,
      "show_logo": true,
      "delivery_method": "direct",
      "customized": true,
      "theme": {
        "primary_color": "#1459c4"
      }
    },
    "defaults": {
      "header": "",
      "body": "PHA+SGkgdGhlcmUsPC9wPg==",
      "footer": "",
      "signature": "PHA+VGhhbmsgeW91LDxicj48c3Ryb25nPltwYXJ0bmVyVGl0bGVdPC9zdHJvbmc+PC9wPg==",
      "subject": "Welcome to [partnerTitle]",
      "custom_html": "PHA+SGkgdGhlcmUsPC9wPg=="
    }
  }
}

422 Validation Error · `422`

{
  "message": "The type field is required.",
  "errors": {
    "type": [
      "The type field is required."
    ]
  }
}

403 Forbidden (platform-owned type) · `403`

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

Errors

Status	Meaning
`401`	The bearer token is missing, expired or invalid
`403`	Forbidden (platform-owned type)
`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/get" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 1, "type": "user_welcome"}'

Updated 10 days ago

Did this page help you?