Skip to content
Developers
API reference API keys

API reference

Upsert deal

customers.UpsertDealWriteAPI key

Create or update a deal by a permanent external reference. Matching is exact within the workspace, resource type and ownership scope. Supplied fields replace their values; omitted fields stay unchanged. Deleted records are not recreated.

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

Access & visibility

Allow customers.UpsertDeal on your API key. Resource read permissions: core:Deal. Resource write permissions: core:Deal.

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.

dataDealRequired

The record's fields.

Deal
Opportunity5 fields
titlestringRequired

Name of the sales opportunity.

stagestringRequired

A stage id from the org's own sales pipeline, in funnel order: lead = Lead, qualified = Qualified, proposal = Proposal, negotiation = Negotiation, won = Won (won), lost = Lost (lost). The list is the org's to change — the pipeline is the core:SalesPipeline entry (edit its stages to add, rename, reorder or re-weight a stage; the ids here follow).

Allowed: "lead", "qualified", "proposal", "negotiation", "won", "lost".

expected_close_datestringOptional

Expected date the opportunity will be won or lost, in YYYY-MM-DD format.

descriptionstringOptional

Business context for the sales opportunity.

lost_reasonstringOptional

Reason recorded when the opportunity is lost.

Value2 fields
amount_oreintegerOptional

Value of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency.

product_linesarray of objectOptional

Products or services proposed in this deal, with quantities, prices and billing frequency.

Item fields
product_refstringOptional

Product record ID.

namestringRequired

Display name.

descriptionstringOptional

Descriptive text.

quantitynumberOptional

Number of units. May be fractional when the product allows it.

Minimum: 0.

unitstringOptional

Unit used for the quantity, such as hours or items.

unit_price_oreintegerOptional

Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only.

agreed_atnumberOptional

Time the commercial terms were agreed, in Unix milliseconds.

agreed_deal_refstringOptional

Deal record ID.

revenue_typestringOptional

Whether this amount is charged once or repeats monthly, quarterly or annually.

Allowed: "one_time", "monthly", "quarterly", "annual".

start_datestringOptional

ISO date (YYYY-MM-DD)

end_datestringOptional

ISO date (YYYY-MM-DD)

Relationships4 fields
company_refstringOptional

ID of a core:Company record. Find it with customers.ListCompanies and use the top-level id. This is not an account ID or a display name.

contact_refstringOptional

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

owner_refstringOptional

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

tagsarray of stringOptional

Stable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.

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.

external_refobjectRequired

Permanent, case-sensitive source identity within this workspace, resource type and private/workspace scope. It is independent of API key rotation and retry receipt expiry.

Nested fields
namespacestringRequired

A stable name for the source system, such as crm-production.

At least 1 character.

idstringRequired

The record ID in that source system.

At least 1 character.

Sync with a permanent external reference

Choose a stable external_ref.namespace for your source system and put its record ID in external_ref.id. Matching is case-sensitive and scoped to this workspace, resource type and private/workspace ownership. The reference survives API key replacement and the 30-day retry receipt window. It does not match records by email or name.

Send the required create fields each time. A missing reference creates a record; an existing reference updates only supplied fields and preserves everything else. created tells you which happened. Use the same idempotency key when retrying a lost response and a new key for a later source change. Concurrent calls cannot create duplicate records. A deleted or inaccessible match is refused; the operation does not restore it or make a replacement.

Use the returned item.id with the regular update operation when you need unset or a conditional expected edit. Changing private chooses a different ownership scope; it does not transfer an existing record.

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.

The public schema lists accepted stage IDs. Labels are presentation text; use the stable stage ID in calls.

itemDealRecordRequired

The requested record, including its metadata and data fields.

DealRecord
idstringRequired

Stable core:Deal 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.

dataDealRequired

The record's fields.

Deal
Opportunity5 fields
titlestringRequired

Name of the sales opportunity.

stagestringRequired

A stage id from the org's own sales pipeline, in funnel order: lead = Lead, qualified = Qualified, proposal = Proposal, negotiation = Negotiation, won = Won (won), lost = Lost (lost). The list is the org's to change — the pipeline is the core:SalesPipeline entry (edit its stages to add, rename, reorder or re-weight a stage; the ids here follow).

Allowed: "lead", "qualified", "proposal", "negotiation", "won", "lost".

expected_close_datestringOptional

Expected date the opportunity will be won or lost, in YYYY-MM-DD format.

descriptionstringOptional

Business context for the sales opportunity.

lost_reasonstringOptional

Reason recorded when the opportunity is lost.

Value2 fields
amount_oreintegerOptional

Value of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency.

product_linesarray of objectOptional

Products or services proposed in this deal, with quantities, prices and billing frequency.

Item fields
product_refstringOptional

Product record ID.

namestringRequired

Display name.

descriptionstringOptional

Descriptive text.

quantitynumberOptional

Number of units. May be fractional when the product allows it.

Minimum: 0.

unitstringOptional

Unit used for the quantity, such as hours or items.

unit_price_oreintegerOptional

Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only.

agreed_atnumberOptional

Time the commercial terms were agreed, in Unix milliseconds.

agreed_deal_refstringOptional

Deal record ID.

revenue_typestringOptional

Whether this amount is charged once or repeats monthly, quarterly or annually.

Allowed: "one_time", "monthly", "quarterly", "annual".

start_datestringOptional

ISO date (YYYY-MM-DD)

end_datestringOptional

ISO date (YYYY-MM-DD)

Relationships4 fields
company_refstringOptional

ID of a core:Company record. Find it with customers.ListCompanies and use the top-level id. This is not an account ID or a display name.

contact_refstringOptional

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

owner_refstringOptional

ID of a core:Person record. Find it with customers.ListPeople and use the top-level id. This is not an account ID or a display name.

tagsarray of stringOptional

Stable tag keys, not labels. Use List tag vocabularies to find the vocabulary for this resource type and field, then List tags for its key/label pairs.

createdbooleanRequired

True when this external reference created a record; false when it matched an existing record.

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": {
        "title": {
          "type": "string",
          "description": "Name of the sales opportunity."
        },
        "stage": {
          "type": "string",
          "enum": [
            "lead",
            "qualified",
            "proposal",
            "negotiation",
            "won",
            "lost"
          ],
          "description": "A stage id from the org's own sales pipeline, in funnel order: lead = Lead, qualified = Qualified, proposal = Proposal, negotiation = Negotiation, won = Won (won), lost = Lost (lost). The list is the org's to change — the pipeline is the `core:SalesPipeline` entry (edit its `stages` to add, rename, reorder or re-weight a stage; the ids here follow)."
        },
        "amount_ore": {
          "type": "integer",
          "description": "Value of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency."
        },
        "product_lines": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "product_ref": {
                "type": "string",
                "description": "Product record ID."
              },
              "name": {
                "type": "string",
                "description": "Display name."
              },
              "description": {
                "type": "string",
                "description": "Descriptive text."
              },
              "quantity": {
                "type": "number",
                "minimum": 0,
                "description": "Number of units. May be fractional when the product allows it."
              },
              "unit": {
                "type": "string",
                "description": "Unit used for the quantity, such as hours or items."
              },
              "unit_price_ore": {
                "type": "integer",
                "description": "Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only."
              },
              "agreed_at": {
                "type": "number",
                "description": "Time the commercial terms were agreed, in Unix milliseconds."
              },
              "agreed_deal_ref": {
                "type": "string",
                "description": "Deal record ID."
              },
              "revenue_type": {
                "type": "string",
                "enum": [
                  "one_time",
                  "monthly",
                  "quarterly",
                  "annual"
                ],
                "description": "Whether this amount is charged once or repeats monthly, quarterly or annually."
              },
              "start_date": {
                "type": "string",
                "description": "ISO date (YYYY-MM-DD)"
              },
              "end_date": {
                "type": "string",
                "description": "ISO date (YYYY-MM-DD)"
              }
            },
            "required": [
              "name"
            ],
            "additionalProperties": false
          },
          "description": "Products or services proposed in this deal, with quantities, prices and billing frequency."
        },
        "company_ref": {
          "type": "string",
          "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name."
        },
        "contact_ref": {
          "type": "string",
          "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
        },
        "owner_ref": {
          "type": "string",
          "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
        },
        "expected_close_date": {
          "type": "string",
          "description": "Expected date the opportunity will be won or lost, in YYYY-MM-DD format."
        },
        "description": {
          "type": "string",
          "description": "Business context for the sales opportunity."
        },
        "lost_reason": {
          "type": "string",
          "description": "Reason recorded when the opportunity is lost."
        },
        "tags": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Stable tag keys, not labels. Use [List tag vocabularies](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/reference/customers/ListTags) for its key/label pairs."
        }
      },
      "required": [
        "title",
        "stage"
      ],
      "additionalProperties": false,
      "description": "The record's fields.",
      "title": "Deal"
    },
    "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."
    },
    "external_ref": {
      "type": "object",
      "description": "Permanent, case-sensitive source identity within this workspace, resource type and private/workspace scope. It is independent of API key rotation and retry receipt expiry.",
      "properties": {
        "namespace": {
          "type": "string",
          "minLength": 1,
          "description": "A stable name for the source system, such as crm-production."
        },
        "id": {
          "type": "string",
          "minLength": 1,
          "description": "The record ID in that source system."
        }
      },
      "required": [
        "namespace",
        "id"
      ],
      "additionalProperties": false
    }
  },
  "required": [
    "external_ref",
    "data"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "external_ref": {
        "namespace": "crm-production",
        "id": "customer-1042"
      },
      "data": {
        "title": "Customer onboarding project",
        "stage": "proposal",
        "amount_ore": 1000000,
        "company_ref": "e_company_example",
        "contact_ref": "e_person_example",
        "expected_close_date": "2026-11-30"
      }
    }
  ]
}
Full response JSON schema
{
  "type": "object",
  "properties": {
    "item": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "Stable core:Deal 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": {
            "title": {
              "type": "string",
              "description": "Name of the sales opportunity."
            },
            "stage": {
              "type": "string",
              "enum": [
                "lead",
                "qualified",
                "proposal",
                "negotiation",
                "won",
                "lost"
              ],
              "description": "A stage id from the org's own sales pipeline, in funnel order: lead = Lead, qualified = Qualified, proposal = Proposal, negotiation = Negotiation, won = Won (won), lost = Lost (lost). The list is the org's to change — the pipeline is the `core:SalesPipeline` entry (edit its `stages` to add, rename, reorder or re-weight a stage; the ids here follow)."
            },
            "amount_ore": {
              "type": "integer",
              "description": "Value of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency."
            },
            "product_lines": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "product_ref": {
                    "type": "string",
                    "description": "Product record ID."
                  },
                  "name": {
                    "type": "string",
                    "description": "Display name."
                  },
                  "description": {
                    "type": "string",
                    "description": "Descriptive text."
                  },
                  "quantity": {
                    "type": "number",
                    "minimum": 0,
                    "description": "Number of units. May be fractional when the product allows it."
                  },
                  "unit": {
                    "type": "string",
                    "description": "Unit used for the quantity, such as hours or items."
                  },
                  "unit_price_ore": {
                    "type": "integer",
                    "description": "Price per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only."
                  },
                  "agreed_at": {
                    "type": "number",
                    "description": "Time the commercial terms were agreed, in Unix milliseconds."
                  },
                  "agreed_deal_ref": {
                    "type": "string",
                    "description": "Deal record ID."
                  },
                  "revenue_type": {
                    "type": "string",
                    "enum": [
                      "one_time",
                      "monthly",
                      "quarterly",
                      "annual"
                    ],
                    "description": "Whether this amount is charged once or repeats monthly, quarterly or annually."
                  },
                  "start_date": {
                    "type": "string",
                    "description": "ISO date (YYYY-MM-DD)"
                  },
                  "end_date": {
                    "type": "string",
                    "description": "ISO date (YYYY-MM-DD)"
                  }
                },
                "required": [
                  "name"
                ],
                "additionalProperties": false
              },
              "description": "Products or services proposed in this deal, with quantities, prices and billing frequency."
            },
            "company_ref": {
              "type": "string",
              "description": "ID of a `core:Company` record. Find it with [customers.ListCompanies](/reference/customers/ListCompanies) and use the top-level `id`. This is not an account ID or a display name."
            },
            "contact_ref": {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            "owner_ref": {
              "type": "string",
              "description": "ID of a `core:Person` record. Find it with [customers.ListPeople](/reference/customers/ListPeople) and use the top-level `id`. This is not an account ID or a display name."
            },
            "expected_close_date": {
              "type": "string",
              "description": "Expected date the opportunity will be won or lost, in YYYY-MM-DD format."
            },
            "description": {
              "type": "string",
              "description": "Business context for the sales opportunity."
            },
            "lost_reason": {
              "type": "string",
              "description": "Reason recorded when the opportunity is lost."
            },
            "tags": {
              "type": "array",
              "items": {
                "type": "string"
              },
              "description": "Stable tag keys, not labels. Use [List tag vocabularies](/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/reference/customers/ListTags) for its key/label pairs."
            }
          },
          "required": [
            "title",
            "stage"
          ],
          "additionalProperties": false,
          "description": "The record's fields.",
          "title": "Deal"
        }
      },
      "required": [
        "id",
        "created_at",
        "updated_at",
        "created_by",
        "private",
        "data"
      ],
      "additionalProperties": false,
      "description": "The requested record, including its metadata and data fields.",
      "title": "DealRecord"
    },
    "created": {
      "type": "boolean",
      "description": "True when this external reference created a record; false when it matched an existing record."
    }
  },
  "required": [
    "item",
    "created"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "item": {
        "id": "e_deal_example",
        "created_at": 1794301200000,
        "updated_at": 1794301200000,
        "created_by": "a_example",
        "private": false,
        "data": {
          "title": "Customer onboarding project",
          "stage": "proposal",
          "amount_ore": 1000000,
          "company_ref": "e_company_example",
          "contact_ref": "e_person_example",
          "expected_close_date": "2026-11-30"
        }
      },
      "created": true
    }
  ]
}

Search by operation name or what you want to build.

Use arrow keys to browse. Enter opens a result.