Skip to main content
This schema describes objects returned by the Background Job endpoints.

A background job that can be used to perform long-running tasks

​
id
string
required
read-only

Unique identifier for the background job

Example:

"675266e304a8e55b17f0228b"

​
workspace_id
string<uuid>
required
read-only

Workspace ID

Example:

"019f985c-6325-7016-8026-da3ba794e60a"

​
type
enum<string>
required

Type of background job

Available options:
move-leads,
import-leads,
export-leads,
update-warmup-accounts,
rename-variable,
broadcast-ai-generate,
broadcast-website-scrape,
import-subscribers-from-crm,
resync-subscriber-crm-tags
Example:

"move-leads"

​
progress
number
required

Progress of the job as a percentage (from 0 to 100)

Required range: 0 <= x <= 100
Example:

0

​
status
enum<string>
required

Job status

Available options:
pending,
in-progress,
success,
failed,
draining,
paused,
cancelled
Example:

"pending"

​
created_at
string
required

Timestamp when the job was created

Example:

"2026-07-25T08:20:19.365Z"

​
updated_at
string
required

Timestamp when the job was last updated

Example:

"2026-07-25T08:20:19.365Z"

​
user_id
null | string<uuid>

The id of the user that triggered the action that created the job

Example:

"019f985c-6325-7016-8026-da3cdc2bb21c"

​
entity_id
null | string<uuid>

The id of the entity that the job is related to

Example:

"019f985c-6325-7016-8026-da3d41c71779"

​
entity_type
enum<string>

Type of entity

Available options:
list,
campaign,
workspace,
broadcast,
subscriber-group-sync,
subscriber-group
Example:

"list"

​
data
object

Data about the job, used to store any additional information we need to process the job