Skip to main content
POST
/
api
/
pipelines
Update or create organization pipeline
curl --request POST \
  --url https://your-instance.example.com/api/pipelines \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "pipelineId": "<string>",
  "stages": [
    {
      "oldStage": "<string>",
      "newStage": "<string>",
      "color": "<string>"
    }
  ],
  "pipelineStages": [
    {
      "_id": "<string>",
      "name": "<string>",
      "color": "<string>",
      "position": 123
    }
  ]
}
'
{
  "message": "<string>",
  "pipeline": {
    "_id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "organizationId": "<string>",
    "type": "Contact",
    "isDefault": true,
    "isActive": true,
    "stages": [
      {
        "name": "<string>",
        "color": "<string>"
      }
    ],
    "pipelineStageIds": [
      "<string>"
    ],
    "pipelineStages": [
      {
        "_id": "<string>",
        "name": "<string>",
        "color": "<string>",
        "position": 123
      }
    ],
    "createdBy": "<string>",
    "updatedBy": "<string>"
  },
  "contactsMigrated": {}
}

Authorizations

Authorization
string
header
required

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

Query Parameters

type
enum<string>
default:Contact
Available options:
Contact,
Application

Body

application/json
name
string
description
string
pipelineId
string
stages
object[]
pipelineStages
object[]

Response

Pipeline updated

message
string
pipeline
object
contactsMigrated
object