Pular para o conteúdo

PATCH /v1/pipelines/{id}

PATCH
/v1/pipelines/{id}
curl --request PATCH \
--url https://seu-endereco-da-api/v1/pipelines/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "type": "sales", "name": "example", "description": "example", "groupName": "example", "staleDays": 1, "intakeEnabled": true, "oneCardPerContact": true, "intakeRules": { "channelIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "originIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "sources": [ "inbound_message" ] }, "intakeWaitDays": 1, "handoffRules": [ { "sourcePipelineId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "stageId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "carryAssignee": true, "carryNote": true, "carryProducts": true, "carryFiles": true } ], "cardFields": [ "example" ], "itemLabelOne": "example", "itemLabelMany": "example", "wonLabel": "example", "wonColor": "blue", "lostLabel": "example", "lostColor": "blue", "showWonColumn": true, "showLostColumn": true }'

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

id
required
string
Media typeapplication/json
object
type
string
Allowed values: sales management
name
string
>= 1 characters
description
string
<= 500 characters
groupName
string
<= 80 characters
staleDays
number
>= 1 <= 3650
intakeEnabled
boolean
oneCardPerContact
boolean
intakeRules
object
channelIds
Array<string>
originIds
Array<string>
sources
Array<string>
Allowed values: inbound_message ad form
intakeWaitDays
number
>= 1 <= 90
handoffRules
Array<object>
object
sourcePipelineId
required
string format: uuid
stageId
required
string format: uuid
carryAssignee
required
boolean
carryNote
required
boolean
carryProducts
required
boolean
carryFiles
required
boolean
cardFields
Array<string>
itemLabelOne
string
nullable >= 1 characters <= 30 characters
itemLabelMany
string
nullable >= 1 characters <= 30 characters
wonLabel
string
>= 1 characters <= 40 characters
wonColor
string
Allowed values: blue purple amber green emerald red orange gray indigo cyan teal lime yellow pink magenta brown
lostLabel
string
>= 1 characters <= 40 characters
lostColor
string
Allowed values: blue purple amber green emerald red orange gray indigo cyan teal lime yellow pink magenta brown
showWonColumn
boolean
showLostColumn
boolean
Media typeapplication/json
object
id
required
string
name
required
string
description
required
string
nullable
groupName
required
string
nullable
type
required

Sales for the commercial funnel, management for a pipeline that tracks internal work; set when the pipeline is created

string
Allowed values: sales management
itemLabelOne
required

Singular name of each item of this board (client, case, process or custom); null uses the default of the type

string
nullable
itemLabelMany
required

Plural name of each item of this board; null exactly when itemLabelOne is null

string
nullable
position
required
number
staleDays
required

Stale limit a new stage of this pipeline starts with; each stage keeps its own staleDays

number
intakeEnabled
required

Whether the pipeline has an intake stage receiving new conversations

boolean
fromNetwork
required

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

boolean
intakeRules
required
object
channelIds

Channels whose new conversations become leads; absent means any

Array<string>
originIds

Contact origins that become leads; absent means any

Array<string>
sources

Sources that become leads; absent means any

Array<string>
Allowed values: inbound_message ad form
intakeWaitDays
required

Days an intake lead waits before it is flagged

number
handoffRules
required

When a deal is won in the source pipeline, a card is created (or the contact’s open card updated) in the stage; only management pipelines have rules

Array<object>
object
sourcePipelineId
required

Sales pipeline whose won deals create a card here

string
sourcePipelineName
required
string
stageId
required

Stage of this pipeline that receives the card

string
stageName
required
string
carryAssignee
required
boolean
carryNote
required
boolean
carryProducts
required
boolean
carryFiles
required
boolean
cardFields
required

Up to 4 extra lines of every card of this pipeline, in order: expected_close, products, next_task, contact_tags, origin, charge, attachments or field: (contact, company or deal); a new pipeline starts with next_task and contact_tags

Array<string>
wonLabel
required

Name of the won column of this board; won stays a deal status, never a stage; a new pipeline starts with Ganho

string
wonColor
required

Color key of the won column, from the stage palette; a new pipeline starts with emerald

string
lostLabel
required

Name of the lost column of this board; lost stays a deal status, never a stage; a new pipeline starts with Perdido

string
lostColor
required

Color key of the lost column, from the stage palette; a new pipeline starts with red

string
showWonColumn
required

Whether the board shows the won column; hidden, deals are still won from the card menu

boolean
showLostColumn
required

Whether the board shows the lost column; hidden, deals are still lost from the card menu

boolean
oneCardPerContact
required

When on, a contact has at most one open deal in this pipeline; applies only to this pipeline, deals in other pipelines never block; a new management pipeline starts on

boolean
openCount
required

Deals still open in this pipeline; null without deals:read

number
nullable
openValueCents
required

Sum in centavos of the open deals; null without deals:read

number
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
stages
required
Array<object>
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

{
"type": "sales",
"intakeRules": {
"sources": [
"inbound_message"
]
},
"stages": [
{
"kind": "open"
}
]
}

Pipeline_type_immutable: the type sent differs from the pipeline’s type