BIbigchange
Jobs

Sets a job to started

Sets a specific job to started. The job must be in a valid state to use this endpoint (required scope jobs:write)

put/v1/jobs/{jobId}/start

Request

  • Base URL
    https://api.bigchange.com
  • URL
    https://api.bigchange.com/v1/jobs/{jobId}/start
  • Auth
    HTTP bearer

Path parameters

jobIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

commentstring nullable

Optional free-form comment to associate with the status update<br/> <br/>Validation:<br/>- Maximum length of 250 characters

statusModifiedAtstring date-time nullable

The UTC timestamp the status change should be recorded as.<br/>If omitted, the current UTC time will be used.<br/> <br/>Validation:<br/>- Must not be a future date/time

Example request

{
  "comment": "Arrived on site",
  "statusModifiedAt": "2025-01-05T14:23:10.0000000+00:00"
}

Response

No Content

Changes

No recorded changes to this operation across all 13 revisions of this API.