Skip to main content
PATCH
Change a transport run

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The run's ID.

Body

application/json
name
string
Minimum string length: 1
scheduled_date
string<date>
origin
string

Empty text keeps the one it has.

destination
string

Empty text keeps the one it has.

status
enum<string>

Moving to confirmed needs a run with no problems.

Available options:
planning,
confirmed,
in_progress,
completed,
cancelled
notes
string | null

Null or empty text clears it.

Response

The run, as it now is.

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>