Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Body

application/json
channel
string | null

EMAIL, SMS, WHATSAPP or LINKEDIN. Needed unless chat_agent_id is sent.

chat_agent_id
string | null

The chat agent that starts the conversation: an id from List or get agents with type chat.

connection_id
string | null

Accepted for compatibility and ignored: the sender account is chosen from the lead's existing conversation.

content
string | null

Content returned by the Sendora API.

Maximum string length: 4096
conversation_id
string | null

The conversation this message belongs to. It identifies the thread inside this workspace's inbox only.

delivery
enum<string>
default:scheduled

One-off email only. scheduled: sent at a human-paced time the mail engine picks, best for deliverability, opens and replies tracked. instant: sent right away.

Available options:
scheduled,
instant
lead_id
string | null

A lead's id: the id from List or get leads.

opening
string | null

With chat_agent_id: the first message. Left out, the agent writes it.

Maximum string length: 1000
phone
string | null

With chat_agent_id: a number with country code, instead of lead_id.

subject
string | null

One-off email: the subject line.

Maximum string length: 255
to
string | null

One-off email: the recipient address, instead of lead_id. Send with subject and content.

Maximum string length: 320

Response

Successful Response

delivery
enum<string>
required

Delivery returned by the Sendora API.

Available options:
scheduled,
instant
status
enum<string>
required

queued: accepted for scheduled sending. sent: handed to the mail server now.

Available options:
queued,
sent
lead_id
string | null

A lead's id: the id from List or get leads.

success
boolean
default:true

Success returned by the Sendora API.