Companies
Create and manage companies
Concepts
Company Identifier
Companies are uniquely identified by your system's company id. Companies can optionally have a domain, but domain must be unique if it's included.
Default Company Variables
These are the default variables for companies in Conversion. Use these keys when updating or retrieving these variables.
company_name
STRING
Company Name
annual_revenue
NUMBER
Annual Revenue
number_of_employees
NUMBER
Number of Employees
industry
STRING
Industry
Batch Upsert Companies
Create or update multiple companies in a single request. To update a company, include their id and any variables you want to update.
Rate limits: 10 / second, 200 companies per batch
Method: POST
Route: /v1/companies/batch
Request Body:
Field Descriptions:
batch(required): List of companies to create/updatedomain(optional): Company domainid(required): Your system's company idsyncToCrm(optional): Defaults tofalse. Denotes if this contact should sync back to your CRM.createdAt(optional): Defaults to now. When the company was created in your system.Should be given in ISO 8601 format
variables(optional): Key-value pairs for custom company fields
Response:
Empty object response.
Get Company by Id
Retrieve a company and it's variables using their id.
Rate limits: 10 / second
Method: GET
Route: /v1/companies/{id}
Response:
Delete Company by Id
Remove a company from Conversion using their id.
Rate limits: 10 / second
Method: DELETE
Route: /v1/companies/{id}
Response:
Empty object response.
Last updated