Pular para o conteúdo

POST /v1/pipelines/{pipelineId}/stages

POST
/v1/pipelines/{pipelineId}/stages
curl --request POST \
--url https://seu-endereco-da-api/v1/pipelines/example/stages \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "example", "colorKey": "blue", "applyTagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "requiresAssignee": true, "requiresAttachment": true, "requiredAttachmentCategory": "contrato", "requiredFieldIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "importantFieldIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "requiresExpectedCloseDate": true, "requiresValue": true, "requiresProducts": true }'

Permissão que a Chave de acesso precisa: Gerenciar pipelines (pipelines:manage).

pipelineId
required
string
Media typeapplication/json
object
name
required
string
>= 1 characters
colorKey
required
string
Allowed values: blue purple amber green emerald red orange gray indigo cyan teal lime yellow pink magenta brown
applyTagIds
Array<string>
requiresAssignee
boolean
requiresAttachment
boolean
requiredAttachmentCategory
string
Allowed values: contrato proposta documento_cliente comprovante outro
requiredFieldIds
Array<string>
importantFieldIds
Array<string>
requiresExpectedCloseDate
boolean
requiresValue
boolean
requiresProducts
boolean
Media typeapplication/json
object
id
required
string
name
required
string
colorKey
required
string
position
required
number
kind
required
string
Allowed values: open intake
requiresAssignee
required
boolean
requiresAttachment
required
boolean
requiredAttachmentCategory
required
string
nullable
staleDays
required

Days in this stage after which an open deal counts as stale; new stages start with the pipeline’s staleDays

number
requiresExpectedCloseDate
required

The deal only enters with an expected close date

boolean
requiresValue
required

The deal only enters with a value above zero

boolean
requiresProducts
required

The deal only enters with at least one product

boolean
requiredFieldIds
required

Custom fields of the contact, the company or the deal that must be filled to enter

Array<string>
importantFieldIds
required

Custom fields of the contact, the company or the deal that should be filled on entry: moving in without them is allowed and the move answers what is missing

Array<string>
applyTagIds
required
Array<string>
requiredTaskCount
required

Task templates marked as required at this stage

number
automationCount
required

Active sequences enrolling on entry to this stage

number
fromNetwork
required

True when the stage came from the network standard; only the network owner renames or removes it

boolean

Example

{
"kind": "open"
}