Skip to main content
POST
Create 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.

Body

application/json

Request body of create_pipeline_stage.

object
enum<string>
required

Which pipeline to append the stage to: person (leads) or company (accounts). Immutable afterwards.

Available options:
person,
company
name
string
required

Stage label, 1..255. Must not collide with a live stage of the same (team, object), compared case-insensitively (409 duplicate_rejected, context.existing_sid).

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

Funnel bucket for the new stage. Drives the chip color and, for a person stage, what a company derives from a member sitting here.

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

Response

create success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
create
item
object
required
already_exists
boolean
required
meta
object
required