Change a company's details

PUT /companies/{companyId}

Every field is optional; a field sent replaces what was there (locations is the whole set afterwards — a location without an id is new; one with an id not on the company is refused with 409 CompanyLocationNotFound; one sent with different details retires that version and mints a new id, since locations are immutable so that what an order pinned never changes; an active location left out is retired), null clears an optional detail, and catalogIds: [] detaches the company from its catalogs, back to the organization's Default. An archived company cannot be changed (409 CompanyArchived). Appends crm.company-updated carrying the whole detail set. Idempotent by content: a retry that says what the record already says appends nothing.

Access

Requires companies:write.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

Retries

Idempotent by content: a retry that says what the record already says appends nothing.

Why every write carries a key: Idempotency and retries.

Facts appended

crm.company-updated

What a fact is: Facts and the journal.

AI agent tool

Agents call this as crm_update_company (CRM: Update company), in the crm toolset.

Connecting an agent: AI agents.

Example

curl

curl -X PUT 'https://crm.getmanifold.io/companies/cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "paymentTermsDays": 45
}'

JavaScript (fetch)

const response = await fetch("https://crm.getmanifold.io/companies/cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d", {
  method: "PUT",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "paymentTermsDays": 45
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();

Request body · application/json

{
  "paymentTermsDays": 45
}

Response · 200 · application/json

{
  "id": "cmp_01a1588a-1f02-7a3b-8c4d-5e6f7a8b9c0d",
  "status": "active",
  "name": "Harbour Ceramics Pty Ltd",
  "externalId": "HC-0042",
  "tags": [
    "wholesale"
  ],
  "roles": [
    "customer"
  ],
  "taxNumber": "51 824 753 556",
  "taxExempt": false,
  "paymentTermsDays": 45,
  "catalogIds": [
    "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
  ],
  "locations": [
    {
      "id": "cloc_01a1588a-1f02-7a3b-8c4d-6f7a8b9c0d1e",
      "name": "Fremantle warehouse",
      "shippingAddress": {
        "firstName": "Receiving",
        "lastName": "Dock",
        "company": "Harbour Ceramics",
        "address1": "14 Kiln Street",
        "city": "Fremantle",
        "province": "Western Australia",
        "provinceCode": "WA",
        "country": "Australia",
        "countryCode": "AU",
        "zip": "6160"
      },
      "billingAddress": {
        "company": "Harbour Ceramics Pty Ltd",
        "address1": "PO Box 412",
        "city": "Fremantle",
        "provinceCode": "WA",
        "countryCode": "AU",
        "zip": "6959"
      },
      "phone": "+61 8 9430 0000",
      "catalogIds": [],
      "retired": false
    }
  ],
  "mainContactId": "psn_01a1588a-0c41-7d2e-9a10-3b5c6d7e8f90",
  "contactCount": 1,
  "createdAt": "2026-10-20T09:05:00.000Z",
  "updatedAt": "2026-10-20T10:00:00.000Z"
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: crm-manager.openapi.json. Base URL https://crm.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

`401`

Refusal	What it means	What to do
`Unauthorized` reason	The token is missing, expired or not one Manifold issued.	Get a fresh token and send the call again.
`TokenAlreadyUsed` tokenId	A single-use app token was already spent.	Mint a new token for this call.

`402`

Refusal	What it means	What to do
`SubscriptionRequired` status	The organization's subscription has lapsed, so writes are refused.	An owner settles billing. Reads still work meanwhile.

`403`

Refusal	What it means	What to do
`TenantRequired` userId	The token names no organization.	Choose the organization, then get a new token.
`ScopeRequired` required	The token's roles do not grant the scope this call needs.	Ask an owner or admin for a role that grants it.

`404`

Refusal	What it means	What to do
`CompanyNotFound` companyId	No such record in this organization.	Check the id in the path or the body.

`409`

Refusal	What it means	What to do
`CompanyArchived` companyId	The company is archived, and an archived company takes no changes.	Use an active company.
`CompanyLocationNotFound` companyId, locationId	The company has no location with that id.	Use a `locationId` from the company's record.
`MirroredFromSource` source	This area is fed by your source system until the organization goes live.	Make the change in the source system, or go live first.

`503`

Refusal	What it means	What to do
`RequestLogUnavailable` tokenId, reason	The service could not record the request, so it did nothing.	Send the same request again shortly.

How refusals work everywhere: Errors.

Used in

A person, a supplier, and a right-to-erasure request, step 7: Change the supplier's terms