CRM Manager API · companies

Register a company: a name

POST /companies

Register a company: a name, optionally an external id, note, tags, roles (customer by default; supplier makes it pickable on a purchase order), tax id, payment terms, optionally the channel catalogs it buys from (catalogIds — an order for the company is priced from the merged set, each SKU at the lowest price any of them lists; the set must share one currency; empty, the company buys from the organization's Default), its locations (a billing and a shipping address under a name each) and its contacts (people already registered — an unknown one is a 404 PersonNotFound; at most one is the main contact).

Appends crm.company-created. reference is required and is the idempotency key: a retry with the same reference returns the company already registered and appends nothing.

Access

Requires companies:write.

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

Retries

reference is required and is the idempotency key: a retry with the same reference returns the company already registered and appends nothing.

A retry with the same key answers 201, with what the first call recorded.

Why every write carries a key: Idempotency and retries.

Facts appended

  • crm.company-created

What a fact is: Facts and the journal.

AI agent tool

Agents call this as crm_create_company (CRM: Create company), in the crm toolset.

Connecting an agent: AI agents.

Example

curl
curl -X POST 'https://crm.getmanifold.io/companies' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN" \
  -H 'Content-Type: application/json' \
  -d '{
  "reference": "onboarding:harbour-ceramics",
  "name": "Harbour Ceramics Pty Ltd",
  "externalId": "HC-0042",
  "tags": [
    "wholesale"
  ],
  "roles": [
    "customer"
  ],
  "taxNumber": "51 824 753 556",
  "paymentTermsDays": 30,
  "catalogIds": [
    "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
  ],
  "locations": [
    {
      "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"
    }
  ]
}'
JavaScript (fetch)
const response = await fetch("https://crm.getmanifold.io/companies", {
  method: "POST",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}`, "Content-Type": "application/json" },
  body: JSON.stringify({
    "reference": "onboarding:harbour-ceramics",
    "name": "Harbour Ceramics Pty Ltd",
    "externalId": "HC-0042",
    "tags": [
      "wholesale"
    ],
    "roles": [
      "customer"
    ],
    "taxNumber": "51 824 753 556",
    "paymentTermsDays": 30,
    "catalogIds": [
      "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
    ],
    "locations": [
      {
        "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"
      }
    ]
  }),
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Request body · application/json
{
  "reference": "onboarding:harbour-ceramics",
  "name": "Harbour Ceramics Pty Ltd",
  "externalId": "HC-0042",
  "tags": [
    "wholesale"
  ],
  "roles": [
    "customer"
  ],
  "taxNumber": "51 824 753 556",
  "paymentTermsDays": 30,
  "catalogIds": [
    "cat_01a15880-2a10-7b2c-8d3e-4f5a6b7c8d9e"
  ],
  "locations": [
    {
      "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"
    }
  ]
}
Response · 201 · 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": 30,
  "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
    }
  ],
  "contactCount": 0,
  "createdAt": "2026-10-20T09:05:00.000Z",
  "updatedAt": "2026-10-20T09:05: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

RefusalWhat it meansWhat 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

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

403

RefusalWhat it meansWhat 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

RefusalWhat it meansWhat to do
PersonNotFound personId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
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

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Send the same request again, with the same key.

How refusals work everywhere: Errors.

Used in