Enable/disable a template type
Overview
Enable or disables sending for a template type. A disabled template sends nothing — no email and no webhook.
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/toggle
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_idis scoped by an ownership check. -
Platform-owned types are forbidden (403) for non-platform companies inside the shared
updateOverride. -
Only the reachable companies differ per role.
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. |
is_enabled | boolean | Yes | true to enable, false to disable. |
{
"company_id": 1,
"type": "review_response_reply",
"is_enabled": true
}Response
data.status(string) —success.data.message(string) —Template updated.
200 OK · 200
200{
"data": {
"status": "success",
"message": "Template updated."
}
}422 Validation Error · 422
422{
"message": "The is_enabled field is required.",
"errors": {
"is_enabled": [
"The is_enabled field is required."
]
}
}Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The template type is platform-managed, or the email-template section is disabled for your account |
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/toggle" \
--header 'Authorization: Bearer <bearer-token>' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{"company_id": 1, "type": "review_response_reply", "is_enabled": true}'Updated 10 days ago
Did this page help you?
