Updates a job either by its CDN Job Id, or its LoadId.
The following updates are supported:
- Reassign Driver (available up to and including job status AtPickup)
- Unassign Driver (available up to and including job status AtPickup)
- Add Vehicle(s) (available up to and including job status AtPickup)
- Remove Vehicle(s): (available up to and including job status Assigned)
Headers
Header | Required | Description |
Authorization: Basic <credentials> | No | The basic authorization header. Not required when using API key. |
Content-Type: application/json | Yes | Indicates that the request and response bodies are in JSON format. |
URL Parameters
Parameter | Required | Usage | Description |
id | No | /jobs/123 | The CDN job ID to update. When omitted, an existing LoadId must be included in the request body |
region | Yes | us|uk|trainingus|traininguk | The target CDN API. |
apikey | No | apikey=[Your API Key] | The API key for this call. Not required when using Authorization header. |
Body
Examples
URL with CDN Job Id
https://vincarrier.cardeliverynetwork.com/<region>/vind2/openapi/jobs/123?apikey=299bde73-d4d0-4684-9e51
URL without CDN Job Id
https://vincarrier.cardeliverynetwork.com/<region>/vind2/openapi/jobs?apikey=299bde73-d4d0-4684-9e51
Body - update by LoadId
{ ... "LoadId": "ExistingLoadId123", ... }
See Also