Update a bulk job

PUT 
/v2/bulk_jobs/:id

Updates a bulk job's name and / or marks a bulk job as 'ready_to_execute'. May only be updated if the bulk job is still in an "open" state.

For additional information on creating bulk jobs, the types of supported bulk jobs, and examples of the bulk job flow, visit the bulk job details page.

Request

Path Parameters

id integerrequired

The id for the bulk job to which the job data relates

application/json

Body

required

ready_to_execute boolean

Whether the job is ready to be executed. Must be true or false.

name string

Name for your bulk job

Responses

200

Success

application/json

Schema

Schema

updated_at date-time

When this bulk job was updated

type string

Type of the Bulk Job.

total integer

Number of total records for this Bulk Job

state string

State of the Bulk Job. Must be one of: open, executing, done.

started_at date-time

When this bulk job started processing. null until bulk job is done

scopes string[]

Scopes

ready_to_execute boolean

Whether the Bulk Job is ready to be executed

processed integer

Number of processed records at the time of request for this Bulk Job

name string

Name of this Bulk Job

marked_ready_at date-time

When this bulk job was marked as ready to execute

id integer

ID of this Bulk Job

finished_at date-time

When this bulk job finished processing

errors integer

Number of errored records at the time of request for this Bulk Job

created_at date-time

When this bulk job was created

Example (from schema)

{
  "updated_at": "2019-01-02T00:00:00-05:00",
  "type": "person/upsert",
  "total": 1234,
  "state": "open",
  "started_at": "2019-01-02T00:00:00-05:00",
  "scopes": [
    "person:set_crm_id"
  ],
  "ready_to_execute": false,
  "processed": 50,
  "name": "Job Name",
  "marked_ready_at": "2019-01-02T00:00:00-05:00",
  "id": 1,
  "finished_at": "2019-01-02T00:00:00-05:00",
  "errors": 23,
  "created_at": "2019-01-01T00:00:00-05:00"
}

Loading...