Create sales pipeline — Brigg developers

Access & visibility

Allow customers.CreateSalesPipeline 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.

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".

privatebooleanOptional

Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance.

Choose ownership deliberately

Omitting private, or setting it to false, creates a workspace-shared record. Set private: true to create a record owned by the approved acting member. Private records require member delegation; a workspace-only credential cannot own a personal record. The credential’s exact resource grants authorize the write; private ownership and project membership remain enforced.

A create is a new record, not an upsert. Reuse the same idempotency key only for retries of that logical creation. For recurring synchronization, use the resource’s upsert operation when available: it matches a permanent external reference. Otherwise keep the returned record ID and use the corresponding update operation for subsequent changes.

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.

Next steps

Download OpenAPI · Versioning & retirement

JSON schemas

Use the complete schemas for validation or client generation.

Full request JSON schema

{
  "type": "object",
  "properties": {
    "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"
    },
    "private": {
      "type": "boolean",
      "description": "Defaults to false: the record is shared with the workspace. True assigns private ownership to the approved acting member and requires member delegation. This is independent of created_by provenance."
    }
  },
  "required": [
    "data"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "data": {
        "name": "Sales pipeline",
        "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
          }
        ]
      }
    }
  ]
}

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": "Sales pipeline",
          "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
            }
          ]
        }
      }
    }
  ]
}

Try the request

Use your API key in a server environment.

Act as a memberRequires administrator-approved delegation.

Fictional values. Replace IDs and business details with values from your workspace.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.CreateSalesPipeline' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "data": {
    "name": "Sales pipeline",
    "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
      }
    ]
  }
}'

TypeScript

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.CreateSalesPipeline", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "data": {
      "name": "Sales pipeline",
      "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
        }
      ]
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "data": {
    "name": "Sales pipeline",
    "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
      }
    ]
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.CreateSalesPipeline",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

cURL

curl 'https://api.brigg.app/v1/operations/customers.CreateSalesPipeline' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Brigg-Act-As: $BRIGG_ACT_AS" \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "data": {
    "name": "Sales pipeline",
    "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
      }
    ]
  }
}'

TypeScript

const actAs = process.env.BRIGG_ACT_AS;
if (!actAs) throw new Error("Set BRIGG_ACT_AS to an approved member account ID.");

const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/customers.CreateSalesPipeline", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Brigg-Act-As": actAs,
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "data": {
      "name": "Sales pipeline",
      "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
        }
      ]
    }
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);

Python

import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "data": {
    "name": "Sales pipeline",
    "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
      }
    ]
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.CreateSalesPipeline",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Brigg-Act-As": os.environ["BRIGG_ACT_AS"],
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise

200 OK Response example

{
  "item": {
    "id": "e_salespipeline_example",
    "created_at": 1791276900000,
    "updated_at": 1791280800000,
    "created_by": "a_jamie",
    "private": false,
    "data": {
      "name": "Sales pipeline",
      "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
        }
      ]
    }
  }
}

Illustrative values, not a live response.