Skip to main content

deal_stage

idinteger

The ID of the stage

deal_pipeline_idinteger

The pipeline the stage belongs to

namestring

The name of the stage, as the board column header shows it

nicknamestring

Short label used where the full name will not fit

objectivestring

What has to happen for a deal to leave this stage

colorstring

Hex colour of the column

Example: #2176ff
stage_typestring

entry is where captured leads land and where a migrated deal falls back to; conclusion closes the funnel. Everything else is regular.

Possible values: [regular, entry, conclusion]

probabilityinteger

Chance of closing a deal that reaches this stage, in percent. Null when the stage has none set, and the client falls back to the stage's position.

Possible values: >= 0 and <= 100

orderinteger

Position of the column in the board

created_atinteger

Unix timestamp of creation

updated_atinteger

Unix timestamp of the last update

deal_stage
{
"id": 0,
"deal_pipeline_id": 0,
"name": "string",
"nickname": "string",
"objective": "string",
"color": "#2176ff",
"stage_type": "regular",
"probability": 0,
"order": 0,
"created_at": 0,
"updated_at": 0
}