post
https://production-api.shoutaboutus.com/api/v1/account/white-label/email-templates/variables
Returns the list of supported variable tokens (with sample values) usable in the header/body/footer/signature content for one template type.
Auth: Both — authentication + an email-template feature check. company_id 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:
| Field | Type | Required | Notes |
|---|---|---|---|
| company_id | integer | Yes | Must be an existing account inside your own account tree. |
| type | string | Yes | Must be a valid EmailTemplateType value. |
Response — { data. } envelope, with nested status + data array of EmailVariableRegistry definitions.
status(string) —success.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.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
