Jobs

Retrieve a job

Retrieve a background job by id to follow its progress. An operation that touches more contacts than fits in one request (for example Delete a custom contact field or Rename a custom field's key above 5,000 holders, or a campaign validation over more than 5,000 recipients) answers 202 with a job. Poll this until status is COMPLETED, FAILED or CANCELED; processed of total is the progress. A failed job keeps the work it finished; retry it from the dashboard (Settings → Jobs). Reading a job takes the read capability of the resource it changes (contacts:read for a custom-field job, campaigns:read for a campaign check). Requires the contacts:read capability.

get/jobs/{id}

Request

  • Base URL: https://www.unitpost.com/api/v1
  • URL: https://www.unitpost.com/api/v1/jobs/{id}
  • Auth: HTTP bearer

Response

The job.

object'job' required
idstring required
kindstring required
status'QUEUED' | 'RUNNING' | 'COMPLETED' | 'FAILED' | 'CANCELED' required
totalinteger nullable required
processedinteger required
failedinteger required
errorstring nullable required
created_atstring required
completed_atstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.