Skip to main content
PATCH
/
companies
/
{id}
Update company
curl --request PATCH \
  --url https://productlane.com/api/v1/companies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "domains": [
    "<string>"
  ],
  "externalIds": [
    "<string>"
  ],
  "autoAdd": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "domains": [
    "<string>"
  ],
  "externalIds": [
    "<string>"
  ],
  "autoAdd": true,
  "size": 123,
  "revenue": 123,
  "tierId": "<string>",
  "statusId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "workspaceId": "<string>"
}

​
Update Company

Update an existing company by its ID. All fields are optional and only provided fields will be updated.

​
Path Parameters

​
id
string
required
Unique identifier of the company to update

​
Request Body

​
name
string
Company name (1-255 characters)
​
domains
string[]
List of domains associated with this company. Used for automatically linking contacts by email domain. If Linear is connected, these domains will be synced to the Linear customer.Each domain must match the pattern: [0-9a-z-]+\.(?:(?:co|or|gv|ac|com)\.)?[a-z]{2,7}$
​
externalIds
string[]
Your own organization IDs for referencing this company. Useful for linking contacts with generic email domains (e.g., @gmail.com) to companies. If Linear is connected, these IDs will be synced as Linear customer externalIds.
​
autoAdd
boolean
Automatically add all existing contacts with matching email domains to this company
​
size
number
Company size (number of employees). If Linear is connected, this will be synced to the Linear customer. Pass null to clear the value.
​
revenue
number
Annual revenue. If Linear is connected, this will be synced to the Linear customer. Pass null to clear the value.
​
tierId
string
Linear customer tier ID. Only works if Linear is connected. Use GET /companies/linear-options to fetch available tier IDs. Pass null to clear the value.
​
statusId
string
Linear customer status ID. Only works if Linear is connected. Use GET /companies/linear-options to fetch available status IDs. Pass null to clear the value.

​
Response

​
id
string
Unique identifier for the updated company
​
name
string
Company name
​
domains
string[]
List of domains associated with the company
​
externalIds
string[]
External IDs for the company
​
autoAdd
boolean
Whether to automatically add contacts with matching domains
​
size
number
Company size (number of employees)
​
revenue
number
Annual revenue
​
tierId
string
Linear customer tier ID
​
statusId
string
Linear customer status ID
​
createdAt
string
Timestamp when the company was created
​
updatedAt
string
Timestamp when the company was last updated
​
workspaceId
string
ID of the workspace this company belongs to

​
Example Request

{
  "name": "Acme Corporation",
  "size": 100,
  "revenue": 2000000,
  "tierId": "tier_456"
}

​
Example Response

{
  "id": "comp_123456789",
  "name": "Acme Corporation",
  "domains": ["acme.com", "acme.io"],
  "externalIds": ["ACME-001"],
  "autoAdd": true,
  "size": 100,
  "revenue": 2000000,
  "tierId": "tier_456",
  "statusId": "status_456",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T11:45:00Z",
  "workspaceId": "ws_123456789"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

Body

application/json
​
name
string
Required string length: 1 - 255
​
domains
string[]
Required string length: 1 - 63
​
externalIds
string[]

Your own organization IDs for referencing this company

Required string length: 1 - 255
​
autoAdd
boolean

Response

Successful response

​
id
string
required
​
name
string
required
​
domains
string[]
required
​
externalIds
string[]
required
​
autoAdd
boolean
required
​
size
integer
required
​
revenue
integer
required
​
tierId
string
required
​
statusId
string
required
​
createdAt
string<date-time>
required
​
updatedAt
string<date-time>
required
​
workspaceId
string
required