Skip to main content
PATCH
Update pipeline stage

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Pipeline stage sid (cr_ps_…).

Required string length: 18
Pattern: ^cr_ps_

Body

application/json

Request body of update_pipeline_stage.

name
string

New label. A collision with another live stage of the same (team, object) is a 409 duplicate_rejected.

Required string length: 1 - 255
category
enum<string>

New funnel bucket. LOCKED on a system stage (key != null): sending a different value there is a 422 validation_failed.

Available options:
cold,
approaching,
engaging,
positive,
nurture,
negative,
disqualified
order
integer

New position, 1..N within its (team, object) pipeline. Siblings recontiguate around it in the same transaction; out of range is a 422. Reordering a person pipeline changes the forward-only rank, so it changes which auto-transitions are allowed to fire.

Required range: x >= 1

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.