Skip to main content
PATCH
/
v1
/
pipelines
/
{id}
Update a pipeline
curl --request PATCH \
  --url https://api4.kinbox.com.br/v1/pipelines/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "position": 123,
  "stages": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "requireds": [
        "<string>"
      ]
    }
  ],
  "rules": [
    {
      "ruleId": "<string>",
      "max": 123,
      "stageId": "<string>"
    }
  ],
  "cadence": [
    {
      "stageId": "<string>",
      "task": {},
      "id": "<string>"
    }
  ],
  "lostReasons": [
    "<string>"
  ],
  "requiredCustomFieldIds": [
    "<string>"
  ],
  "privacy": {
    "type": "private",
    "groupIds": [
      "<string>"
    ],
    "userId": "<string>"
  },
  "authorId": 123
}
'
{
  "id": "<string>",
  "name": "<string>",
  "position": 123,
  "stages": [
    {
      "id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "requireds": [
        "<string>"
      ]
    }
  ],
  "rules": [
    {
      "ruleId": "<string>",
      "max": 123,
      "stageId": "<string>"
    }
  ],
  "cadence": [
    {
      "stageId": "<string>",
      "task": {},
      "id": "<string>"
    }
  ],
  "lostReasons": [
    "<string>"
  ],
  "requiredCustomFieldIds": [
    "<string>"
  ],
  "privacy": {
    "type": "private",
    "groupIds": [
      "<string>"
    ],
    "userId": "<string>"
  },
  "authorId": 123
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
name
string

Nome do funil

​
position
number

Posição do funil

​
stages
object[]

Estágios do funil

​
rules
object[]

Regras do funil

​
cadence
object[]

Cadência associada ao funil

​
lostReasons
string[]
​
requiredCustomFieldIds
string[]
​
privacy
object
​
authorId
number

Response

200 - application/json
​
id
string
required
​
name
string
required

Nome do funil

​
position
number
required

Posição do funil

​
stages
object[]
required

Estágios do funil

​
rules
object[]
required

Regras do funil

​
cadence
object[]

Cadência associada ao funil

​
lostReasons
string[]
​
requiredCustomFieldIds
string[]
​
privacy
object
​
authorId
number