Leads email send
Send a one-off email to this lead, with optional follow-ups, now or at a time.
POST/api/v1/leads/{id}/email/send
This call sends email or changes what sends. A key needs the send scope, and the Try it panel asks you to confirm before it runs.
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Body
A JSON object. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
mailbox_idrequired | body | Mailbox to send from. |
subjectrequired | body | Subject. |
format | body | plain or html. |
body | body | Plain text body. |
body_html | body | HTML body when format is html. |
follow_ups | body, array | Up to 3: [{day_offset, body}]; they stop on a reply. |
mode | body | now or scheduled. |
scheduled_at | body | ISO time when mode is scheduled. |
style | body | The draft style picked. |
track_opens | body, boolean | Add an open pixel. Off by default. |
track_clicks | body, boolean | Rewrite links to count clicks. Off by default. |
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/leads/{id}/email/send" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"mailbox_id": "",
"subject": "",
"format": "",
"body": "",
"body_html": "",
"follow_ups": [],
"mode": "",
"scheduled_at": "",
"style": "",
"track_opens": false,
"track_clicks": false
}'CLI
sales-engine leads email-send <id> --mailbox-id "..." --subject "..."The JSON above lists every documented field with a typed placeholder; send only the ones you mean.
Response
A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.
Shape
{
"data": { ... }
}Run it below to see the live shape for your workspace.
Try it
Runs against this server, as the workspace behind the key. Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Path
requiredThe record's id.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/leads/%7Bid%7D/email/send
Fill the path first.