Move a lead to a pipeline stage

Moves a lead to another stage in your company's pipeline, as dragging a card on the board does.
Get stage IDs from GET /lead_stages.

If the destination belongs to a different outcome than the lead's current one, the move carries
that outcome's full effect and permissions: a won stage closes the lead as won (creating its job),
a lost stage closes it as lost (the reason defaults to other if you don't send one), an inactive
stage marks it inactive, and an open stage reopens it, which requires a role that can act on
every record.

Unlike most lead endpoints, the response is a short confirmation rather than the lead.

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

ID of the destination stage.

string

Loss reason to record when the destination is a lost stage. Defaults to other.

string

Optional notes to record when the destination is a lost stage.

Responses

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