This schema describes objects returned by the Background Job endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Unique identifier for the background job (read-only) |
workspace_id | string (uuid) | Yes | Workspace ID (read-only) |
user_id | string (uuid), nullable | No | The id of the user that triggered the action that created the job (read-only) |
type | string | Yes | Type of background job. Possible values: move-leads (Move Leads), import-leads (Import Leads), export-leads (Export Leads), update-warmup-accounts (Update Warmup Accounts), rename-variable (Rename Variable) |
entity_id | string (uuid), nullable | No | The id of the entity that the job is related to |
entity_type | string | No | Type of entity. Possible values: list (The entity is a lead list), campaign (The entity is a campaign), workspace (The entity is a workspace) |
data | object | No | Data about the job, used to store any additional information we need to process the job |
progress | number | Yes | Progress of the job as a percentage (from 0 to 100) |
status | string | Yes | Job status. Possible values: pending (The background job is waiting in the queue to be processed), in-progress (The background job is being processed), success (The background job has been successfully processed), failed (The background job has failed) |
created_at | string | Yes | Timestamp when the job was created |
updated_at | string | Yes | Timestamp when the job was last updated |