Choose who sends an email

Overview

Choose whether we send an email type directly, or deliver its content to your webhook so your system sends it.

Use webhook delivery when you want emails to come from your own mail system.

You'll need the type and the method.

The method is saved. webhook needs a type that supports it (supports_webhook in List email types) and an active webhook subscription.

Prerequisites

• A bearer token. See Authentication.
• The account's id (company_id), with the email templates section turned on.
• The email type, from List email types.
• For webhook: an active webhook subscription.

Base URL

Endpoint

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

Authentication

Partner or Account token

• company_id must be inside your own account tree. A Partner token can use any account under the partner; an Account token only its own account.
• An account outside your tree, or one that doesn't exist, is rejected with 422.
• The email templates section must be turned on for the account's partner (email_templates_enabled in Get branding). When it's off, every email template call for that account returns 403 with The email template section is disabled for this account.
• Types managed centrally by the platform return 403 (This template is managed centrally and cannot be edited here.).

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Request payload

{
  "company_id": 5994,
  "type": "user_welcome",
  "delivery_method": "webhook",
  "webhook_subscription_id": 18
}

Response body

The payload is inside data.

Response payload

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

Examples

Success payload

See Response payload.

Error payload

403 Email templates section is off

{
  "message": "The email template section is disabled for this account.",
  "status": "error",
  "errors": []
}

403 Type managed centrally

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

422 Type doesn't support webhook delivery

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

422 No active webhook subscription

{
  "message": "No active webhook subscription is configured for this account. Add and activate a webhook subscription before switching this email to webhook delivery.",
  "errors": {
    "delivery_method": [
      "No active webhook subscription is configured for this account. Add and activate a webhook subscription before switching this email to webhook delivery."
    ]
  }
}

422 delivery_method isn't allowed

{
  "message": "The selected delivery method is invalid.",
  "errors": {
    "delivery_method": [
      "The selected delivery method is invalid."
    ]
  }
}

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": 5994, "type": "user_welcome", "delivery_method": "webhook", "webhook_subscription_id": 18}'