Skip to content
Developers v1
API reference API keys

API reference

Update sales pipeline

customers.UpdateSalesPipelineWriteAPI key

Update a sales pipeline by ID. Omitted fields stay unchanged; use unset to remove fields and expected to prevent overwriting a concurrent change.

POST/v1/operations/customers.UpdateSalesPipeline
On this page

Access & visibility

Allow customers.UpdateSalesPipeline on your API key. Resource read permissions: core:SalesPipeline. Resource write permissions: core:SalesPipeline.

Workspace access by default. Private member data requires approved member delegation through Brigg-Act-As; the key supplies permissions while private ownership and project boundaries remain enforced.

Set up authentication · Choose permissions

Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.

idstringRequired

ID of a visible core:SalesPipeline record. Find it with customers.ListSalesPipelines. Use the record's top-level id, not a business field or account ID.

dataSalesPipelineOptional

The fields to set.

SalesPipeline
Pipeline2 fields
namestringOptional

Name of the sales pipeline.

is_defaultbooleanOptional

Whether this is the workspace's default sales pipeline.

Ordered stages1 fields
stagesarray of objectOptional

Sales stages in funnel order. Keep stage IDs stable: deals refer to them. Exactly one won and one lost stage appear last; probability is an integer percentage from 0 to 100 for weighted sales value.

Item fields
idstringRequired

Stable stage ID referenced by deals. Keep it when changing the label.

labelstringRequired

Human-readable stage name.

kindstringRequired

Whether this stage is open, won or lost.

Allowed: "open", "won", "lost".

probabilitynumberOptional

Integer percentage from 0 to 100 used for weighted sales value.

tonestringOptional

Display color token for the stage.

Allowed: "gray", "blue", "violet", "peach", "soon", "accent", "warn".

unsetarray of stringOptional

Keys of data to remove.

Each item: "name", "stages", "is_default".

expectedobjectOptional

Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {"$absent":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.

Nested fields
namestring or objectOptional

Commit only if the previous name value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

stagesarray of object or objectOptional

Commit only if the previous stages value matches; use $absent to require that this field is missing.

Nested fields

Variant 1

idstringRequired

Stable stage ID referenced by deals. Keep it when changing the label.

labelstringRequired

Human-readable stage name.

kindstringRequired

Whether this stage is open, won or lost.

Allowed: "open", "won", "lost".

probabilitynumberOptional

Integer percentage from 0 to 100 used for weighted sales value.

tonestringOptional

Display color token for the stage.

Allowed: "gray", "blue", "violet", "peach", "soon", "accent", "warn".

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

is_defaultboolean or objectOptional

Commit only if the previous is_default value matches; use $absent to require that this field is missing.

Nested fields

$absent = true

$absenttrueRequired

Require the field to be missing, rather than present with a null value.

Always true.

Update without losing changes

Send only the business fields you want to change in data; omitted fields stay unchanged. Use unset to remove an optional field. Setting a field to null is a different action and is allowed only when its schema permits null.

Use expected for a conditional update: supply the values you last read for the fields whose concurrent changes would matter. {"$absent": true} expects a missing field. A conflict means you must read the record again and decide how to reconcile the change. Keep the same idempotency key when retrying the original action; use a new key for a revised action.

Response

Returns 200 OK with a JSON body.

Record metadata sits outside data. Timestamps created_at and updated_at are Unix milliseconds. Optional business fields may be absent; absence does not mean false or zero. A field accepts null only when its type includes null.

itemSalesPipelineRecordRequired

The requested record, including its metadata and data fields.

SalesPipelineRecord
idstringRequired

Stable core:SalesPipeline record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited.

created_atnumberRequired

Time the record was created, in Unix milliseconds.

updated_atnumberRequired

Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.

created_bystring or nullRequired

Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID.

privatebooleanRequired

True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules.

dataSalesPipelineRequired

The record's fields.

SalesPipeline
Pipeline2 fields
namestringRequired

Name of the sales pipeline.

is_defaultbooleanOptional

Whether this is the workspace's default sales pipeline.

Ordered stages1 fields
stagesarray of objectOptional

Sales stages in funnel order. Keep stage IDs stable: deals refer to them. Exactly one won and one lost stage appear last; probability is an integer percentage from 0 to 100 for weighted sales value.

Item fields
idstringRequired

Stable stage ID referenced by deals. Keep it when changing the label.

labelstringRequired

Human-readable stage name.

kindstringRequired

Whether this stage is open, won or lost.

Allowed: "open", "won", "lost".

probabilitynumberOptional

Integer percentage from 0 to 100 used for weighted sales value.

tonestringOptional

Display color token for the stage.

Allowed: "gray", "blue", "violet", "peach", "soon", "accent", "warn".

Errors & retries

Set BRIGG_REQUEST_ID once for each logical action. The samples send it as Idempotency-Key. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See HTTP errors and safe retries and limits.

HTTP status Code What to do
400 invalid_json Send a JSON object with Content-Type: application/json.
400 invalid_input Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters.
401 invalid_key The workspace API key is missing, invalid or revoked.
403 forbidden Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member.
404 not_found The requested operation or resource is not available to this credential.
429 rate_limited Wait for Retry-After before retrying. Reuse the original Idempotency-Key.
409 conflict A supplied expected value no longer matches. Read the record again before deciding whether to retry.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "ID of a visible `core:SalesPipeline` record. Find it with [customers.ListSalesPipelines](/developers/reference/customers/ListSalesPipelines). Use the record's top-level `id`, not a business field or account ID."
    },
    "data": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Name of the sales pipeline."
        },
        "stages": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Stable stage ID referenced by deals. Keep it when changing the label."
              },
              "label": {
                "type": "string",
                "description": "Human-readable stage name."
              },
              "kind": {
                "type": "string",
                "enum": [
                  "open",
                  "won",
                  "lost"
                ],
                "description": "Whether this stage is open, won or lost."
              },
              "probability": {
                "type": "number",
                "description": "Integer percentage from 0 to 100 used for weighted sales value."
              },
              "tone": {
                "type": "string",
                "enum": [
                  "gray",
                  "blue",
                  "violet",
                  "peach",
                  "soon",
                  "accent",
                  "warn"
                ],
                "description": "Display color token for the stage."
              }
            },
            "required": [
              "id",
              "label",
              "kind"
            ],
            "additionalProperties": false
          },
          "description": "Sales stages in funnel order. Keep stage IDs stable: deals refer to them. Exactly one won and one lost stage appear last; probability is an integer percentage from 0 to 100 for weighted sales value."
        },
        "is_default": {
          "type": "boolean",
          "description": "Whether this is the workspace's default sales pipeline."
        }
      },
      "required": [],
      "additionalProperties": false,
      "description": "The fields to set.",
      "title": "SalesPipeline"
    },
    "unset": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "name",
          "stages",
          "is_default"
        ]
      },
      "description": "Keys of `data` to remove."
    },
    "expected": {
      "type": "object",
      "description": "Prior business-field values that must still match before the write. Use fields from this record’s data object, without the data. prefix. Use {\"$absent\":true} as a value to require an absent field. A mismatch returns 409 conflict. See the conditional example for this resource.",
      "additionalProperties": false,
      "properties": {
        "name": {
          "description": "Commit only if the previous name value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Name of the sales pipeline."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "stages": {
          "description": "Commit only if the previous stages value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Stable stage ID referenced by deals. Keep it when changing the label."
                  },
                  "label": {
                    "type": "string",
                    "description": "Human-readable stage name."
                  },
                  "kind": {
                    "type": "string",
                    "enum": [
                      "open",
                      "won",
                      "lost"
                    ],
                    "description": "Whether this stage is open, won or lost."
                  },
                  "probability": {
                    "type": "number",
                    "description": "Integer percentage from 0 to 100 used for weighted sales value."
                  },
                  "tone": {
                    "type": "string",
                    "enum": [
                      "gray",
                      "blue",
                      "violet",
                      "peach",
                      "soon",
                      "accent",
                      "warn"
                    ],
                    "description": "Display color token for the stage."
                  }
                },
                "required": [
                  "id",
                  "label",
                  "kind"
                ],
                "additionalProperties": false
              },
              "description": "Sales stages in funnel order. Keep stage IDs stable: deals refer to them. Exactly one won and one lost stage appear last; probability is an integer percentage from 0 to 100 for weighted sales value."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        },
        "is_default": {
          "description": "Commit only if the previous is_default value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "boolean",
              "description": "Whether this is the workspace's default sales pipeline."
            },
            {
              "type": "object",
              "properties": {
                "$absent": {
                  "type": "boolean",
                  "const": true,
                  "description": "Require the field to be missing, rather than present with a null value."
                }
              },
              "required": [
                "$absent"
              ],
              "additionalProperties": false
            }
          ]
        }
      }
    }
  },
  "required": [
    "id"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "id": "e_salespipeline_example",
      "data": {
        "name": "Customer sales"
      }
    }
  ]
}
Full response JSON schema
{
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:SalesPipeline record ID. Keep this top-level value when reading or referring to this record. Available actions are linked under Next steps; an ID does not imply the resource can be edited."
        },
        "created_at": {
          "type": "number",
          "description": "Time the record was created, in Unix milliseconds."
        },
        "updated_at": {
          "type": "number",
          "description": "Time the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads."
        },
        "created_by": {
          "type": [
            "string",
            "null"
          ],
          "description": "Account that originally created the record, or null for a workspace/system-originated record. This is provenance, not its current owner or a Person record ID."
        },
        "private": {
          "type": "boolean",
          "description": "True for a member-owned private record. An API key needs approved delegation to that owner; false alone does not bypass resource grants or other access rules."
        },
        "data": {
          "type": "object",
          "properties": {
            "name": {
              "type": "string",
              "description": "Name of the sales pipeline."
            },
            "stages": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Stable stage ID referenced by deals. Keep it when changing the label."
                  },
                  "label": {
                    "type": "string",
                    "description": "Human-readable stage name."
                  },
                  "kind": {
                    "type": "string",
                    "enum": [
                      "open",
                      "won",
                      "lost"
                    ],
                    "description": "Whether this stage is open, won or lost."
                  },
                  "probability": {
                    "type": "number",
                    "description": "Integer percentage from 0 to 100 used for weighted sales value."
                  },
                  "tone": {
                    "type": "string",
                    "enum": [
                      "gray",
                      "blue",
                      "violet",
                      "peach",
                      "soon",
                      "accent",
                      "warn"
                    ],
                    "description": "Display color token for the stage."
                  }
                },
                "required": [
                  "id",
                  "label",
                  "kind"
                ],
                "additionalProperties": false
              },
              "description": "Sales stages in funnel order. Keep stage IDs stable: deals refer to them. Exactly one won and one lost stage appear last; probability is an integer percentage from 0 to 100 for weighted sales value."
            },
            "is_default": {
              "type": "boolean",
              "description": "Whether this is the workspace's default sales pipeline."
            }
          },
          "required": [
            "name"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "SalesPipeline"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "The requested record, including its metadata and data fields.",
      "title": "SalesPipelineRecord"
    }
  },
  "required": [
    "item"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_salespipeline_example",
        "created_at": 1791276900000,
        "updated_at": 1791280800000,
        "created_by": "a_jamie",
        "private": false,
        "data": {
          "name": "Customer sales",
          "is_default": true,
          "stages": [
            {
              "id": "lead",
              "label": "Lead",
              "kind": "open",
              "probability": 10
            },
            {
              "id": "won",
              "label": "Won",
              "kind": "won",
              "probability": 100
            },
            {
              "id": "lost",
              "label": "Lost",
              "kind": "lost",
              "probability": 0
            }
          ]
        }
      }
    }
  ]
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.