Nurture test send
Send one nurture email to your own address as a test, tags filled with sample values, from a client mailbox with its signature.
POST/api/v1/nurture/test
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
Body
A JSON object, required. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
subjectrequired | body | Subject. |
body | body | Body of a plain email. |
content_mode | body | plain or rich. One of plain, rich. |
body_html | body | The HTML of a rich email. |
sequence_id | body | Sends with this sequence's signature. |
mailbox_id | body | Client mailbox to send from; the first one when left out. |
to | body | Recipient; defaults to you. Your own address, a member's or a workspace mailbox. |
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/nurture/test" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"subject": "",
"body": "",
"content_mode": "plain",
"body_html": "",
"sequence_id": "",
"mailbox_id": "",
"to": ""
}'CLI
sales-engine nurture test-send --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.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/nurture/test