Frameworks update
Edit any field of a framework, pause or resume it (status), or renumber it (sno).
PATCH/api/v1/frameworks/{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 | Framework name. |
category | body | Where it sits: opener, follow_up, closing, or sequence (several emails from the first). One of opener, follow_up, closing, sequence. |
type | body | Two or three words naming the approach, such as Problem agitate solve. |
step_from | body, integer | Earliest email it suits: 1 is the first email, 2 the first follow-up. |
step_to | body, integer | Latest email it suits; null for any later email. |
needs | body, array | Data it depends on: signal, content, new_role, relationship, website_visit, behavior, asset, channel, investor, earnings. Only signal and content are seen on a lead; any other need means it is used only when a campaign names it. |
structure | body, array | The parts in order: [{label, text}]. |
how_it_works | body, array | Two or three short points on why it works. |
example | body, array | Complete example emails in order: [{label, subject, body}]; several for a sequence. |
example_kind | body | emails when the examples are a run of emails in order, variants when they are alternatives (one per role, angle or trigger). One of emails, variants. |
status | body | active is routed, paused is not. One of active, paused. |
sno | body, integer | Its number in the list. |
Example
curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/frameworks/{id}" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "",
"category": "opener",
"type": "",
"step_from": 0,
"step_to": 0,
"needs": [],
"structure": [],
"how_it_works": [],
"example": [],
"example_kind": "emails",
"status": "active",
"sno": 0
}'CLI
sales-engine frameworks 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/frameworks/%7Bid%7D
Fill the path first.