Access & visibility
Allow customers.CreateDeal 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.
Request fields
Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
dataDealRequiredThe record's fields.
Deal
Opportunity5 fields
titlestringRequiredName of the sales opportunity.
stagestringRequiredA 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_datestringOptionalExpected date the opportunity will be won or lost, in YYYY-MM-DD format.
descriptionstringOptionalBusiness context for the sales opportunity.
lost_reasonstringOptionalReason recorded when the opportunity is lost.
Value2 fields
amount_oreintegerOptionalValue of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency.
product_linesarray of objectOptionalProducts or services proposed in this deal, with quantities, prices and billing frequency.
Item fields
product_refstringOptionalProduct record ID.
namestringRequiredDisplay name.
descriptionstringOptionalDescriptive text.
quantitynumberOptionalNumber of units. May be fractional when the product allows it.
Minimum: 0.
unitstringOptionalUnit used for the quantity, such as hours or items.
unit_price_oreintegerOptionalPrice per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only.
agreed_atnumberOptionalTime the commercial terms were agreed, in Unix milliseconds.
agreed_deal_refstringOptionalDeal record ID.
revenue_typestringOptionalWhether this amount is charged once or repeats monthly, quarterly or annually.
Allowed: "one_time", "monthly", "quarterly", "annual".
start_datestringOptionalISO date (YYYY-MM-DD)
end_datestringOptionalISO date (YYYY-MM-DD)
Relationships4 fields
company_refstringOptionalID 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_refstringOptionalID 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_refstringOptionalID 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 stringOptionalStable 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.
privatebooleanOptionalDefaults 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.
The public schema lists accepted stage IDs. Labels are presentation text; use the stable stage ID in calls.
itemDealRecordRequiredThe requested record, including its metadata and data fields.
DealRecord
idstringRequiredStable 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_atnumberRequiredTime the record was created, in Unix milliseconds.
updated_atnumberRequiredTime the record most recently changed, in Unix milliseconds. Use with overlapping windows for incremental reads.
created_bystring or nullRequiredAccount 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.
privatebooleanRequiredTrue 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.
dataDealRequiredThe record's fields.
Deal
Opportunity5 fields
titlestringRequiredName of the sales opportunity.
stagestringRequiredA 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_datestringOptionalExpected date the opportunity will be won or lost, in YYYY-MM-DD format.
descriptionstringOptionalBusiness context for the sales opportunity.
lost_reasonstringOptionalReason recorded when the opportunity is lost.
Value2 fields
amount_oreintegerOptionalValue of the opportunity in Norwegian øre. 1000000 is NOK 10,000. Deals are NOK-only; do not supply another currency.
product_linesarray of objectOptionalProducts or services proposed in this deal, with quantities, prices and billing frequency.
Item fields
product_refstringOptionalProduct record ID.
namestringRequiredDisplay name.
descriptionstringOptionalDescriptive text.
quantitynumberOptionalNumber of units. May be fractional when the product allows it.
Minimum: 0.
unitstringOptionalUnit used for the quantity, such as hours or items.
unit_price_oreintegerOptionalPrice per unit in Norwegian øre; 100000 is NOK 1,000. Product lines use NOK only.
agreed_atnumberOptionalTime the commercial terms were agreed, in Unix milliseconds.
agreed_deal_refstringOptionalDeal record ID.
revenue_typestringOptionalWhether this amount is charged once or repeats monthly, quarterly or annually.
Allowed: "one_time", "monthly", "quarterly", "annual".
start_datestringOptionalISO date (YYYY-MM-DD)
end_datestringOptionalISO date (YYYY-MM-DD)
Relationships4 fields
company_refstringOptionalID 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_refstringOptionalID 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_refstringOptionalID 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 stringOptionalStable 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.
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
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](/developers/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](/developers/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](/developers/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](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/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."
}
},
"required": [
"data"
],
"additionalProperties": false,
"examples": [
{
"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](/developers/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](/developers/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](/developers/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](/developers/reference/customers/ListTagVocabularies) to find the vocabulary for this resource type and field, then [List tags](/developers/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"
}
},
"required": [
"item"
],
"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"
}
}
}
]
}