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

EnvironmentURL
Productionhttps://production-api.shoutaboutus.com
Developmenthttps://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_id is 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:
FieldTypeRequiredDescription
company_idintegerYesMust be an existing account inside your own account tree.
typestringYesValid EmailTemplateType value.
is_enabledbooleanYestrue 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

{
  "data": {
    "status": "success",
    "message": "Template updated."
  }
}

422 Validation Error · 422

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

Errors

StatusMeaning
401The bearer token is missing, expired or invalid
403The template type is platform-managed, or the email-template section is disabled for your account
422Validation Error
500Unexpected 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}'

Did this page help you?