v1

latestOpenAPI 3.1.02026-08-061,5107704.5 MB

Pipeline

Pipelines.update

Modifies Pipeline or Pipelines with given id(s)

patch/entities/Pipelines/{id}

Path parameters

idstring uuid required

ID of Pipeline to update

Query parameters

validation-levelinteger

Specify validation level of Pipeline on update. Use them as bit mask: 0 - validate each field on entity, 2 - validate only changed fields, 4 - validate only system fields, 8 - allows to override readonly fields, 16 - allows to set entity on deleted relationship.

Request body

colorinteger

Display color of the pipeline label, encoded as a 24-bit RGB integer: (red << 16) | (green << 8) | blue.

namestring

Name of the entity and its default text representation.

revisioninteger

Revision when entity was lastly changed.

Example request

{
  "color": 1,
  "name": "string",
  "revision": 1,
  "steps": [
    {
      "description": "string",
      "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
      "name": "string",
      "percent": 1,
      "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
      "sort_order": 1,
      "timeframe": 1,
      "revision": 1
    }
  ]
}

Response

Modification confirmation. Returns resulting Pipeline

successboolean

True when response succeeded, false on error.

Example response

{
  "success": true,
  "data": {
    "id": "01234567-abcd-dcba-ffff-000000000000",
    "modified": "2019-01-01T00:00:00",
    "created": "2019-01-01T00:00:00",
    "color": 1,
    "name": "string",
    "revision": 1,
    "steps": [
      {
        "description": "string",
        "lead_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "name": "string",
        "percent": 1,
        "quote_process_id": "01234567-abcd-dcba-ffff-000000000000",
        "sort_order": 1,
        "timeframe": 1,
        "revision": 1
      }
    ]
  }
}