Nurture update
Edit a sequence; steps sent here replace the old ones.
PATCH/api/v1/nurture/sequences/{id}
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Body
A JSON object. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
name | body | Name. |
trigger | body | booked, no_show, follow_up or won. One of booked, no_show, follow_up, won. |
category | body | pre_call, post_call, follow_up, onboarding or no_show. One of pre_call, post_call, follow_up, onboarding, no_show. |
status | body | active or paused. One of active, paused. |
auto_send | body, boolean | Send without approval. |
enroll_mode | body | auto enrols every booking; manual waits for you to turn it on per booking. One of auto, manual. |
mailbox_id | body | Mailbox it sends from; the first sending mailbox when left out. |
steps | body, array | Steps in order: [{mailbox_id (a client mailbox, optional), anchor (booked_at, meeting_start, meeting_end, stage_entered), offset_minutes (negative is before the anchor), subject, body, content_mode (plain or rich), body_html (the HTML of a rich email; its plain body is worked out from it), condition (replied, no_reply, no_show, showed), answer_match (a branch: only clients whose booking answer equals it; * takes the clients no other branch at the same time took), variant (a or b: an A/B split of a branch, half the deals each)}]. Merge tags: {{first_name}}, {{name}}, {{company}}, {{event_name}}, {{looking_for}} (what they want to implement, from the booking form), {{meeting_date}}, {{meeting_hour}} (in the client's time zone), {{meeting_time}}, {{meeting_link}}, {{booking_link}}, {{reschedule_link}}, {{sender_name}}; {{key|fallback}} fills a blank. |
signature | body | The sequence signature, HTML or plain text; it replaces the mailbox signature. |
signature_format | body | template, html or plain. One of template, html, plain. |
signature_fields | body, object | Template fields: {sign_off, title, photo_url, linkedin_url, site_label, site_url}. |
Example
curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/nurture/sequences/{id}" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "",
"trigger": "booked",
"category": "pre_call",
"status": "active",
"auto_send": false,
"enroll_mode": "auto",
"mailbox_id": "",
"steps": [],
"signature": "",
"signature_format": "template",
"signature_fields": {}
}'CLI
sales-engine nurture update <id>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
PATCH /api/v1/nurture/sequences/%7Bid%7D
Fill the path first.