API Reference
  1. CircleHQ API Documentation
  2. CIRCLEHQ REST API
  3. Transactional Messaging

Send message

post
https://api.circlehq.co/api/v1/transactional/send

Queues a transactional Email/SMS message using a template key and variables payload.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Delivery channel for this send request

Allowed:
string
required

Verified sender ID used for transactional email delivery

string

Client-generated dedupe identifier for this send request

string
required

Stable key of the transactional template to use for this message

string
required

Recipient address for the selected template channel (email or phone number)

variables
object
required

Template variable map used to render placeholders in subject/body

Responses

Updated 5 months ago

Did this page help you?
Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 5 months ago

Did this page help you?