Skip to main content
POST
Change a pitch

Authorizations

Authorization
string
header
required

A Searchable API key, created under Manage Account → Integrations → API Keys. Send as Authorization: Bearer sea_xxxxx. Every key carries one or more scopes (read, write, admin) and may optionally be bound to a single project — see Getting started.

Headers

Idempotency-Key
string

Optional client-generated key (e.g. a UUID). Retrying with the same key within 24h replays the original stored response (X-Idempotent-Replay: true) instead of repeating the side effect. See Idempotency.

Path Parameters

pitchId
string<uuid>
required

The pitch's id, from GET /api/mcp/pitches. A pitch is a project, so its id works with every project endpoint too.

Body

application/json
action
enum<string>
required

What to do with the pitch: reactivate, extend, refresh, convert, decline, hide or unhide.

Available options:
reactivate,
extend,
refresh,
convert,
decline,
hide,
unhide
dryRun
boolean

Run every check the action runs and return the preview with 200, changing nothing. Without it, the action acts at once.

Response

The action was carried out, or, with dryRun: true, the preview of it.

The pitch after the action, or, with dryRun: true, the preview of it.

pitch
object
required

One pitch as the Pitches tab shows it, worked out by the app's own rules. A converted pitch is a ConvertedPitchRecord instead.

success
boolean
required
message
string
required

One sentence of what the action did, e.g. what a decline means for reactivating the pitch later.

joinedExistingRun
boolean

Present, and true, only on a refresh that joined a report already running for the pitch (its first report, or one an earlier refresh or an unfiltered Run report started): it started no new report and used none of the pitch's manual refreshes.