Edit

[POST] .../v1/pipeline/edit

Edits a CRM pipeline. Rename a CRM pipeline, toggle whether it is active or make it the default pipeline for its entity type. The method changes only fields present in the request; setting is_default to true clears the default flag on other pipelines of the same entity type when a row is affected and returns row_affected with changed ids. The request body is required, id must be positive and name is optional but cannot be blank when provided and is limited to 200 characters. The caller must have CRM pipeline edit permission; missing body, invalid id or name, denied access, missing pipeline, uniqueness violations and storage errors are returned as HTTP 200 ErrorResult.

Request Parameters

Name Type Required Description
active Boolean Optional Active flag.
id Int64 Required Pipeline ID.
is_default Boolean Optional Indicates whether this is the default pipeline.
name String Optional New pipeline name. If provided, it cannot be empty.

Request Example

{
  "id": 7,
  "name": "Lead pipeline B2B",
  "is_default": true,
  "active": true
}

Response Parameters

Name Type Description
ok Boolean Indicates whether the request completed successfully.
result Update Update operation result.

Response Example

{
  "ok": true,
  "result": {
    "row_affected": 1,
    "ids": [
      7
    ]
  }
}