Rebuild Step Emails

Regenerates the queued emails at one step from its current configuration, and the step that finishes a copy change.

Creating, editing or deleting an email template, and switching a step between AI, TEMPLATE and PER_CONTACT, all change what the step should produce but leave the emails already queued against a prospect as they were. This call rebuilds them. Emails that have already been sent are never touched, so it is safe to call on a live ICP.

Call it once after you have finished editing a step rather than after each change, and once per step you changed. shouldReprocess on Get Sequence Step tells you whether a step is waiting for one.

This also writes missing emails, but rewrites every existing unsent email at the step, including previews, at 1 AI credit each on an AI step. To finish a large import while preserving successful copy, use Process Step Emails with mode: MISSING. To retry generation failures, use that operation with mode: FAILED. TEMPLATE and PER_CONTACT imports run automatically; per-contact copy changes rebuild the affected emails themselves.

The rebuild runs in the background and the response returns as soon as it is queued, so a large ICP keeps rebuilding after the call completes. Poll Get Step Email Status every 10 seconds until isComplete, or inspect failed / waiting-for-credit counts. shouldReprocess: false is not a completion signal: it clears when work is queued. A TEMPLATE step with no templates, or whose copy is empty, is rejected rather than queued: rebuilding it would leave the step unable to produce an email. A PER_CONTACT step rebuilds from each prospect's own copy; prospects without any are left unsent until an import supplies it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Get this from Settings > Workspaces. Starts with "account_".

string
required

Get this from Settings > Workspaces > Workspace ID column. On read endpoints you may also pass the literal value all to span every workspace in the account.

string
required

ICP id. Get it from List ICPs or the ICPs page in the dashboard.

Body Params
integer
required
0 to 3

The step to rebuild, zero-based.

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json