Create a pipeline
Creates a pipeline. Add its columns afterwards with Create a pipeline stage.
Endpoint
POST/pipelines
Body
| Name | Type | Required | Description |
|---|---|---|---|
organization_id | integer | Yes | Organization to create the pipeline in. |
name | string | Yes | Display name. |
type | string | Yes | deal, conversation or ticket. |
description | string | No | Description. |
visibility | string | No | public (default) or private. |
config | object | No | Settings. Deal pipelines may set defaultDealStatus (open, won, lost, all). Conversation pipelines may set channel_scope, e.g. ["whatsapp:12", "instagram"] (channel scope); WhatsApp numbers must belong to the organization. |
created_by_user_id is set to the API key's user.
Request
Response
json
Errors
| Status | When |
|---|---|
400 Bad Request | name, type or organization_id is missing, or a value is invalid. |
403 Forbidden | The API key's user has the member role in the organization. |
Report an issue with this documentation
Please log in to report issues with our documentation.