​
Introduction

Channel Accounts represent configured integrations that enable your tenant to send communications through various channels (email, SMS, etc.). Each channel account is associated with a specific channel integration and contains the necessary metadata to send messages through that channel (e.g. the base domain for example). Please see the API Reference here for more information.
Currently only email via Reach Managed is supported.

​
Structure

A channel account consists of:
  • Status: Can be either active or deactivated
  • Business ID: Links the account to a specific tenant this account belongs to.
  • Channel Integration ID: Specifies which integration this account is configured for. See Channel Integrations for more information.
  • Channel Account Metadata: Contains provider-specific configuration details. See Channel Account Metadata for more information.

​
Channel Account Metadata

​
Reach Managed Email

For Reach-managed email accounts, the following configuration is required:
  • Type: reach-managed or twilio
For Reach-managed email accounts, the following configuration is required:
  • Base Domain: The base domain of the channel account (e.g. marketing.embedreach.org or marketing.yourdomain.com)
  • Message Stream: Choose between:
    • broadcast: For marketing and promotional emails
    • outbound: For transactional emails
For Twilio the following configuration is required:
  • accountSid: The accountSid for the Twilio account
  • apiKeySid: The apiKeySid for the Twilio account
  • apiKeySecret: The apiKeySecret for the Twilio account