Companies
Create or update a company
Creates a new company or updates an existing one.
Uses the external companyId as the unique identifier for upsert matching.
If a company with the given companyId already exists, it will be updated.
Otherwise, a new company will be created.
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
companyId | string | Yes | External company ID from your system (unique identifier) |
name | string | Yes | Company name |
monthlySpend | number | No | Monthly spend/revenue from this company |
industry | string | No | Industry the company operates in |
website | string | No | Company website URL |
plan | string | No | Current plan/subscription name |
companySize | number | No | Number of employees |
createdAt | string | No | When the company was created (ISO 8601) |
customFields | object | No | Custom field values |
Example Request
{
"companyId": "comp_12345",
"name": "Acme Inc",
"monthlySpend": 5000,
"industry": "Technology",
"website": "https://acme.com",
"plan": "enterprise",
"companySize": 250,
"customFields": {
"region": "EMEA",
"tier": "gold"
}
}Example Response
{
"object": "company",
"id": "507f1f77bcf86cd799439011",
"companyId": "comp_12345",
"name": "Acme Inc",
"monthlySpend": 5000,
"industry": "Technology",
"website": "https://acme.com",
"plan": "enterprise",
"linkedUsers": 1,
"companySize": 250,
"lastActivity": "2025-01-15T00:00:00.000Z",
"customFields": { "region": "EMEA", "tier": "gold" },
"createdAt": "2025-01-01T12:00:00.000Z",
"updatedAt": "2025-01-15T10:30:00.000Z"
}Error Responses
- 400 Bad Request - Invalid company data
Version Availability
This endpoint is only available in API version 2026-01-01.nova and newer.
Body
application/json
External company ID from your system. Used as the unique identifier for upsert matching.
Required string length:
1 - 500Example:
comp_12345When the company was created in your system (ISO 8601)
Example:
2024-01-15T10:30:00ZCustom field values on the company. Values can be string, number, boolean, null, or array of primitives.
Response
application/json
Success
ISO date when company was last updated
Example:
2025-01-10T15:30:00.000Z