Delete company — Brigg developers

Access & visibility

Allow customers.DeleteCompany on your API key. Resource read permissions: core:Company. Resource write permissions: core:Company.

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:Company record. Find it with customers.ListCompanies. Use the record's top-level id, not a business field or account ID.

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.

domainstring or objectOptional

Commit only if the previous domain 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.

industrystring or objectOptional

Commit only if the previous industry 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.

descriptionstring or objectOptional

Commit only if the previous description 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.

owner_refstring or objectOptional

Commit only if the previous owner_ref 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.

websitestring or objectOptional

Commit only if the previous website 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.

org_numberstring or objectOptional

Commit only if the previous org_number 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.

registry_countrystring or objectOptional

Commit only if the previous registry_country 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.

addressstring or objectOptional

Commit only if the previous address 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.

postal_codestring or objectOptional

Commit only if the previous postal_code 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.

citystring or objectOptional

Commit only if the previous city 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.

countrystring or objectOptional

Commit only if the previous country 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.

phonestring or objectOptional

Commit only if the previous phone 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.

tagsarray of string or objectOptional

Commit only if the previous tags 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.

product_linesarray of object or objectOptional

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

Nested fields

Variant 1

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)

$absent = true

$absenttrueRequired

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

Always true.

profileobject (2 variants)Optional

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

Nested fields

Variant 1

summarystringOptional

Short summary of the source information.

highlightsarray of stringOptional

Key points extracted from the source information.

$absent = true

$absenttrueRequired

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

Always true.

Deletion and retries

A successful response reports whether this call removed the record or it was already absent. Check cascaded for dependent record IDs returned by the operation. Retrying the same action uses the original idempotency key. A successful deletion is not an archive you can restore through this operation.

To avoid deleting a record someone has changed, read it first and put the relevant prior business values in expected. Keys are relative to data, not prefixed with data.. Use {"$absent": true} to require a missing field. A mismatch returns 409 conflict; read again and decide whether deletion is still appropriate. A revised action needs a new idempotency key.

Response

Returns 200 OK with a JSON body.

deletedstringRequired

deleted when this request removed the record; already_deleted when it was already absent.

Allowed: "deleted", "already_deleted".

cascadedarray of stringOptional

IDs of dependent records deleted with this 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.
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:Company` record. Find it with [customers.ListCompanies](/developers/reference/customers/ListCompanies). Use the record's top-level `id`, not a business field or account ID."
    },
    "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": "Company's display name; use org_number and registry_country for its registered identity."
            },
            {
              "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
            }
          ]
        },
        "domain": {
          "description": "Commit only if the previous domain value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Website hostname, without a scheme or path."
            },
            {
              "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
            }
          ]
        },
        "industry": {
          "description": "Commit only if the previous industry value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "bygg",
                "handel",
                "konsulent",
                "it",
                "helse",
                "restaurant",
                "eiendom",
                "transport",
                "finans",
                "utdanning",
                "industri",
                "offentlig",
                "annet"
              ],
              "description": "Industry classification. Send the stored enum value; the English label is for display only. Values: `bygg` — Construction; `handel` — Retail and wholesale; `konsulent` — Consulting; `it` — Information technology; `helse` — Healthcare; `restaurant` — Restaurants; `eiendom` — Real estate; `transport` — Transport; `finans` — Finance; `utdanning` — Education; `industri` — Manufacturing; `offentlig` — Public sector; `annet` — Other."
            },
            {
              "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
            }
          ]
        },
        "description": {
          "description": "Commit only if the previous description value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Business description recorded for this company."
            },
            {
              "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
            }
          ]
        },
        "owner_ref": {
          "description": "Commit only if the previous owner_ref value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "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."
            },
            {
              "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
            }
          ]
        },
        "website": {
          "description": "Commit only if the previous website value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Company website URL, including https://."
            },
            {
              "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
            }
          ]
        },
        "org_number": {
          "description": "Commit only if the previous org_number value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Organisation number from the company register, stored as text to preserve leading zeros."
            },
            {
              "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
            }
          ]
        },
        "registry_country": {
          "description": "Commit only if the previous registry_country value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "enum": [
                "NO",
                "SE"
              ],
              "description": "Country of registration: NO for Norway or SE for Sweden."
            },
            {
              "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
            }
          ]
        },
        "address": {
          "description": "Commit only if the previous address value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Street address, including building or unit when applicable."
            },
            {
              "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
            }
          ]
        },
        "postal_code": {
          "description": "Commit only if the previous postal_code value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Postal code as text, preserving leading zeros."
            },
            {
              "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
            }
          ]
        },
        "city": {
          "description": "Commit only if the previous city value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Postal town or city."
            },
            {
              "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
            }
          ]
        },
        "country": {
          "description": "Commit only if the previous country value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Country associated with the address or record."
            },
            {
              "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
            }
          ]
        },
        "phone": {
          "description": "Commit only if the previous phone value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "string",
              "description": "Phone number including its country calling code."
            },
            {
              "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
            }
          ]
        },
        "tags": {
          "description": "Commit only if the previous tags value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "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."
            },
            {
              "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
            }
          ]
        },
        "product_lines": {
          "description": "Commit only if the previous product_lines value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "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 agreed with this company, including quantity, price and billing frequency."
            },
            {
              "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
            }
          ]
        },
        "profile": {
          "description": "Commit only if the previous profile value matches; use $absent to require that this field is missing.",
          "anyOf": [
            {
              "type": "object",
              "properties": {
                "summary": {
                  "type": "string",
                  "description": "Short summary of the source information."
                },
                "highlights": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  },
                  "description": "Key points extracted from the source information."
                }
              },
              "additionalProperties": false,
              "description": "Generated or supplied company profile, with a summary and key facts."
            },
            {
              "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_company_example"
    }
  ]
}

Full response JSON schema

{
  "type": "object",
  "properties": {
    "deleted": {
      "type": "string",
      "enum": [
        "deleted",
        "already_deleted"
      ],
      "description": "deleted when this request removed the record; already_deleted when it was already absent."
    },
    "cascaded": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "IDs of dependent records deleted with this record."
    }
  },
  "required": [
    "deleted"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "deleted": "deleted"
    }
  ]
}

Try the request

Use your API key in a server environment.

Example scenarioAct 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.DeleteCompany' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_company_example"
}'

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.DeleteCompany", {
  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({
    "id": "e_company_example"
  }),
});
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 = {
  "id": "e_company_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.DeleteCompany",
    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.DeleteCompany' \
  -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 '{
  "id": "e_company_example"
}'

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.DeleteCompany", {
  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({
    "id": "e_company_example"
  }),
});
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 = {
  "id": "e_company_example"
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.DeleteCompany",
    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

{
  "deleted": "deleted"
}

Illustrative values, not a live response.

Use a value you actually read. A concurrent change refuses the write with 409 conflict.

Request

cURL

curl 'https://api.brigg.app/v1/operations/customers.DeleteCompany' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "id": "e_company_example",
  "expected": {
    "name": "Example Consulting"
  }
}'

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.DeleteCompany", {
  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({
    "id": "e_company_example",
    "expected": {
      "name": "Example Consulting"
    }
  }),
});
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 = {
  "id": "e_company_example",
  "expected": {
    "name": "Example Consulting"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.DeleteCompany",
    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.DeleteCompany' \
  -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 '{
  "id": "e_company_example",
  "expected": {
    "name": "Example Consulting"
  }
}'

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.DeleteCompany", {
  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({
    "id": "e_company_example",
    "expected": {
      "name": "Example Consulting"
    }
  }),
});
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 = {
  "id": "e_company_example",
  "expected": {
    "name": "Example Consulting"
  }
}
request = Request(
    "https://api.brigg.app/v1/operations/customers.DeleteCompany",
    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

{
  "deleted": "deleted"
}

Illustrative values, not a live response.