Sales Engine
API documentation
CampaignsOperation campaigns.leadOutcome

Campaigns lead outcome

Set where a lead ended up in this campaign and what closing them was worth; typed by a person, never by the AI.

PATCH/api/v1/campaigns/{id}/leads/{leadId}
Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Path

NameInDescription
idrequiredpathThe record's id.
leadIdrequiredpathThe lead's id.

Body

A JSON object. Fields not listed are ignored.

NameInDescription
stagebodymeeting, converted, closed, lost, or null to go back to what the sends say.
revenue_usdbodyClosed revenue in dollars (a number), or null.

Example

curl
curl -X PATCH "https://crm.ashwanth.dev/api/v1/campaigns/{id}/leads/{leadId}" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "stage": "",
  "revenue_usd": ""
}'
CLI
sales-engine campaigns lead-outcome <id> <leadId>

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 lead's id.
Every documented field is listed above; leave out the ones you do not need.
Request
PATCH /api/v1/campaigns/%7Bid%7D/leads/%7BleadId%7D
Fill the path first.

Also in Campaigns