Skip to main content
PATCH
Edit jobs (with possible partial updates)

Authorizations

Authorization
string
header
required

Get a token from auth/login endpoint and then pass it in the Authorization HTTP header in every subsequent API call. For more information visit our help center.

Body

application/json

Job parts to update and the changes to apply

jobs
object[]
required

Job parts to update.

Required array length: 1 - 100 elements
clearDateDue
boolean

When true, clears the due date on the jobs.

customFields
object

Batch update of custom field instances

dateDue
string<date-time>

Due date to set on the jobs. Accepts an ISO 8601 date-time with a time zone designator (Z or a numeric offset such as +00:00/-05:00, e.g. 2026-08-29T15:50:00+00:00); the same format without a designator (e.g. 2026-08-29T15:50:00) returns 400 Bad Request. A space-separated yyyy-MM-dd HH:mm value (e.g. 2026-08-29 15:50) has no offset and is interpreted as UTC. A legacy MMM d, yyyy h:mm:ss a value (e.g. Aug 29, 2026 3:50:00 PM) is also accepted and parsed in the server's default time zone, not UTC.

providers
object[]

Providers to assign to the jobs.

status
enum<string>

Status to set on the jobs.

Available options:
NEW,
ACCEPTED,
DECLINED,
REJECTED,
DELIVERED,
EMAILED,
COMPLETED,
CANCELLED

Response

OK

errors
object[]

Errors and their counts encountered during the update

updated
integer<int32>

Number of successfully updated job parts