Sales Engine
API documentation
CampaignsOperation campaigns.rewriteStep

Campaigns rewrite step

Improve one step with AI: a job rewrites the subject and body in a variant on your instruction, then re-checks the guardrails.

POST/api/v1/campaigns/{id}/steps/{step}/rewrite
Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Path

NameInDescription
idrequiredpathThe record's id.
steprequiredpathThe step number, counted from 1.

Body

A JSON object. Fields not listed are ignored.

NameInDescription
variantbodya, b or c, default a.
instructionbodyWhat to change: shorter, lead with the proof, drop the second paragraph.

Example

curl
curl -X POST "https://crm.ashwanth.dev/api/v1/campaigns/{id}/steps/{step}/rewrite" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "variant": "",
  "instruction": ""
}'
CLI
sales-engine campaigns rewrite-step <id> <step>

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
required
The record's id.
required
The step number, counted from 1.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/campaigns/%7Bid%7D/steps/%7Bstep%7D/rewrite
Fill the path first.

Also in Campaigns