Update a pipeline

PATCH/v1/crm/pipelines/{pipeline_id}

Scope: crm:write

Updates the fields you send and leaves the rest unchanged. Setting is_default to true makes every other pipeline in your organization non-default.

Headers

AuthorizationstringRequired
Bearer followed by a space and your API key, for example Bearer vk_….

Path parameters

pipeline_idstring · uuidRequired
ID of the pipeline.

Request body

is_activeboolean or null
Whether this pipeline is active (inactive pipelines are hidden)
is_defaultboolean or null
Set as the default pipeline for new deals
namestring or null
Pipeline name
at most 2,000 charactersExample "Enterprise Sales"

Response

200

messagestringRequired
pipelineobjectRequired
The updated pipeline
Show 6 child attributesHide child attributes
- namestringRequired
  Pipeline name
  Example "Enterprise Sales"
- created_atstring · date-time or null
  When the pipeline was created
  Example "2024-01-15T10:30:00+00:00"
- idstring or null
  Pipeline ID
  Example "c1d2e3f4-a5b6-7890-cdef-123456789012"
- is_activeboolean
  Whether this pipeline is active
  Default true
- is_defaultboolean
  Whether this is the default pipeline
  Default false
- updated_atstring · date-time or null
  When the pipeline was last updated
  Example "2024-01-20T14:45:00+00:00"
successboolean
Default true

Errors

Errors share one JSON body: success, error, message, optional details, and request_id.

Status	Code	Meaning
400	VALIDATION_ERROR	The request didn't match the endpoint's schema: a missing or malformed field, a bad query parameter, or a value out of range. `details.errors` lists each failing field with its `field`, `message` and `type`.
400	NO_UPDATES	The update request contained no fields to change.
401	UNAUTHORIZED	The `Authorization` header is missing or malformed, or the API key is unknown or has been deactivated.
401	API_KEY_EXPIRED	The API key is past its expiry date. Create a new key in the Victoria AI app.
403	INSUFFICIENT_SCOPE	The API key doesn't have the scope this endpoint requires, such as `leads:write`.
403	ORGANIZATION_DEACTIVATED	The organization that owns this API key has been deactivated.
404	PIPELINE_NOT_FOUND	No pipeline with this ID exists in your organization.
404	NOT_FOUND	No endpoint matches the path. A resource ID in the path that isn't a valid UUID also answers `NOT_FOUND`.
413	PAYLOAD_TOO_LARGE	The request body is larger than 1 MB.
429	RATE_LIMITED	Too many requests for this API key: more than 100 a minute to one endpoint, or 600 a minute in total. Retry after the number of seconds in the `Retry-After` header. See Rate limits.
500	INTERNAL_ERROR	Something failed on our side. The response never includes internal details; quote its `request_id` when you contact support.
503	UPSTREAM_TIMEOUT	A service the API depends on timed out. The request is safe to retry.
503	AUTH_UNAVAILABLE	The API key couldn't be checked because the authentication service was unavailable. The request is safe to retry.

Response headers

Header	Description
`X-Request-ID`	Correlation ID for the request, also returned as `request_id` in error bodies. Send your own `X-Request-ID`, up to 128 letters, digits, `.`, `_`, `:` or `-`, and it's used instead.
`RateLimit-Limit`	Requests allowed to this endpoint per minute.
`RateLimit-Remaining`	Requests you can still send to this endpoint right now.
`RateLimit-Reset`	Seconds until the endpoint's full limit is available again.
`Retry-After`	On a `429`: seconds to wait before retrying.