Create Job (Single-User API Key)

Query Params
boolean
required
Defaults to false

If true, validated jobs will be created even if non-validated ones exist.

Body Params
string
required

A unique identifier for the job (max 250 characters).

string

The earliest time the delivery should start (ISO-8601).

string

The latest time the delivery should be completed (ISO-8601).

pickup_address
object

Pickup location details.

string

Additional pickup details.

int32

Delivery zone ID.

pickup
object
deliver_address
object
required

Delivery location details.

string

Additional delivery details.

customer
object
required

Customer details.

string

Additional notes for the job.

int32

Sub-brand ID (positive integer).

int32

Label ID (positive integer).

labels
array of int32s

Array of label IDs.

labels
skill_sets
array of int32s

Array of skill set IDs.

skill_sets
string

Job title.

string

Additional title field.

string

Additional title field.

string

Job description.

string
enum

Job status.

Allowed:
int32

Driver's member ID (required if status is "assigned").

delivery_interval
object

Delivery interval details.

cargoes
object

Cargo details.

boolean
Defaults to false

If true, sends a rating reminder.

string

A custom redirect URL.

string
enum
Allowed:
int32
int32
int32
int32
Responses

Language
Credentials
Query
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json