Skip to main content

​
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 supports email via Reach Managed and Twilio integrations.

​
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.
  • Name: Optional friendly name for the account
  • Creator Origin: Indicates how the account was created (manual or template)

​
Channel Account Metadata

​
Supported Channel Account Types

​
Reach Managed Email (reach-managed)

For Reach-managed email accounts, the following configuration is required:
  • Type: reach-managed
  • Domain Prefix: The prefix domain of the channel account (e.g. marketing.embedreach.org or marketing.yourdomain.com)
Response fields (populated after configuration):
  • Base Domain: The full domain of the channel account
  • Message Stream: Either broadcast or outbound
  • DKIM Verified: Boolean indicating if DKIM has been verified
  • DMARC Verified: Boolean indicating if DMARC has been verified
  • Verified Return Path: Boolean indicating if return path has been verified

​
Twilio (twilio)

For Twilio accounts, the following configuration is required:
  • Type: twilio