Skip to content
/
Create Pipeline

Create Pipeline

Request

Creates a new pipeline in the system to create pipeline stages for, unlocking the ability to track a deal's progress through the sale cycle.

Security
ApiKey
Body
namestringrequired

The name of the Pipeline, typically reflecting the sales funnel or opportunity workflow.

is_enabledboolean

Indicates whether syncs for this Pipeline are enabled; differs from IsArchived.

Default:true
curl -i -X POST \
  https://developer.getparallax.com/_mock/api-documentation/swagger/v1/pipelines \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "is_enabled": true
  }'

Responses

Created

Bodyapplication/json
idstring, (uuid)

The unique identifier of the Pipeline in Parallax.

namestring

The name of the Pipeline, typically reflecting the sales funnel or opportunity workflow.

currency_codestring

The ISO currency code associated with the Pipeline, used for financial values tied to deals.

is_enabledboolean

Indicates whether syncs for this Pipeline are enabled; differs from IsArchived.

archivedboolean

Indicates whether the Pipeline is archived and no longer active in Parallax.

Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "currency_code": "string",
  "is_enabled": true,
  "archived": true
}