BIbigchange
Jobs

Schedule or unschedule a job

Changed on

Updates the schedule of a specific job. The job status must be either new, scheduled or unscheduled to use this endpoint (required scope jobs:write)

put/v1/jobs/{jobId}/schedule

Request

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

Path parameters

jobIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

resourceIdinteger nullable

The unique identifier of the resource assigned to this job. If the chosen resource is not active for job watch, the request will be rejected with a 422. If null and the chosen vehicle id is fixed to a resource, this will be automatically populated

vehicleIdinteger nullable

The unique identifier of the vehicle assigned to this job. If null and the chosen resource id is fixed to a vehicle, this will be automatically populated

plannedStartAtstring date-time nullable

The UTC timestamp of when the job is planned to start

Example request

{
  "resourceId": 5514123,
  "vehicleId": 5514123,
  "plannedStartAt": "2022-11-29T11:00:00.0000000+00:00",
  "assistantIds": [
    {
      "resourceId": 12356
    }
  ]
}

Response

No Content

Changes