Skip to main content
POST
Plan a transport run

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Body

application/json
name
string
required
scheduled_date
string<date>
required
origin
string
required

Where the run starts, in your words.

destination
string
required

Where the run ends, in your words.

notes
string

Response

The run, as it was created.

id
string
required
name
string
required
scheduled_date
string<date>
required
origin
string
required
destination
string
required
status
enum<string>
required
Available options:
planning,
confirmed,
in_progress,
completed,
cancelled
legs
object[]
required

In order.

animals
object[]
required

The animals on the run, by name.

problems
object[]
required

Every reason the run cannot be confirmed yet. Empty when it is ready.

notes
string | null
created_at
string<date-time>
updated_at
string<date-time>