Companies Bulk Job

A bulk job for creating, updating, or deleting companies asynchronously. Track the job status using the state field.

idstring

The unique identifier for the bulk job.

Example:"job_v2_1"

typestring

The type of the object.

Value:"companies.bulk.job"

Example:"companies.bulk.job"

statestring

The current state of the job.

Enum:"pending""running""completed""completed_with_errors"

Example:"running"

created_atinteger, (date-time)

The time the job was created as a UNIX timestamp.

Example:1713360000

updated_atinteger, (date-time)

The time the job was last updated as a UNIX timestamp.

Example:1713360060

completed_atinteger or null, (date-time)

The time the job completed as a UNIX timestamp. Null if not yet completed.

Example:1713360120

tasksArray of objects

The tasks that make up this bulk job.

urlstring

The URL to check the job status.

Example:"https://api.intercom.io/companies/bulk/job_v2_1"

{
  "id": "job_v2_1",
  "type": "companies.bulk.job",
  "state": "running",
  "created_at": 1713360000,
  "updated_at": 1713360060,
  "completed_at": 1713360120,
  "tasks": [
    { … }
  ],
  "url": "https://api.intercom.io/companies/bulk/job_v2_1"
}