Sales Engine
API documentation
OpenAPI Get a key
CampaignsOperation campaigns.updateStep

Edit a campaign step

Edit a step: purpose, notes, the day it sends, plain or rich body per variant (subject_a, body_a, body_html_a, content_mode). Shape fields lock after launch.

PATCH/api/v1/campaigns/{id}/steps/{step}
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.

No body. Send the fields you want to change as a JSON object; the record's own fields apply.

Example

curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/campaigns/{id}/steps/{step}" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY"
CLI
sales-engine campaigns update-step <id> <step>

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.
Request
PATCH /api/v1/campaigns/%7Bid%7D/steps/%7Bstep%7D
Fill the path first.

Also in Campaigns

GET List campaignsPOST Create a campaignGET Get a campaignPATCH Update a campaignDELETE Delete a draft campaignPOST Import lead lists into a campaignDELETE Campaigns remove listsGET List the leads in a campaignPOST Approve, reject or add campaign leadsPOST Campaigns audiencePATCH Campaigns lead outcomeGET Campaigns signature defaultsPOST Campaigns suggest nameDELETE Remove a lead from a campaignGET Campaigns get workflowPUT Campaigns set workflowPOST Set the campaign sequencePOST Campaigns set formatPOST Campaigns rewrite stepPOST Write the campaign copyGET Preview the rendered emailsGET Get one lead's copyPATCH Edit one lead's copyPOST Send a test emailGET Get the launch checklistPOST Launch a campaignPOST Pause, resume or cancel a campaignGET Get the campaign timelineGET Campaigns warningsGET List the emails a campaign sentGET Get campaign analyticsGET List reactivation candidatesPOST Create a reactivation campaignPOST Build a reactivation campaign from filters