Set delivery method (direct/webhook)

Overview

Switches a template type between Direct Send (email) and Webhook delivery. Webhook delivery posts rendered content to the partner's webhook URL at send time and requires an active webhook subscription. Email-only types cannot be set to webhook.

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

POST /api/v1/account/white-label/email-templates/delivery-method

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.

• Only the reachable companies differ per role.

Rate limit

• No rate limit.

Request body

• Body:

{
  "company_id": 1,
  "type": "user_welcome",
  "delivery_method": "webhook",
  "webhook_subscription_id": 5
}

Response

• data.status (string) — success.
• data.message (string) — Template updated.

200 OK · 200

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

422 Validation Error · 422

{
  "message": "This email type does not support webhook delivery.",
  "errors": {
    "delivery_method": [
      "This email type does not support webhook delivery."
    ]
  }
}

Errors

Example request

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