Skip to main content
PATCH
Change a saved place

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The saved place.

Body

application/json

On a PATCH every field is optional and a field left out keeps what it had; an address sent with nothing in it is cleared.

name
string
required
Required string length: 1 - 120
place_type
enum<string> | null
Available options:
residence,
shelter,
vet,
break_stop,
other,
null
address
object

The place, as the six address fields (Phase 437). Every part is optional and a key not listed here is refused. Sent as an object and returned as one; an address with nothing in it is stored as nothing.

notes
string | null
contact
object | null

Who to ring at this place (Phase 449b). An address gets a van to a car park; a name and a number get an animal out of it. Either half may be empty; both empty reads back as null. Only rewritten when the key is sent, so a patch about a date never clears a number somebody finally got hold of. An unknown field is refused rather than dropped.

Response

The saved place.

id
string
required
name
string
required

What a driver reads. Unique within the organization, case aside.

place_type
enum<string> | null

The same kinds a place on a run has.

Available options:
residence,
shelter,
vet,
break_stop,
other,
null
address
object | null

The six fields, or null when nobody has said.

notes
string | null

What a driver should know when they get there.

created_at
string<date-time>
updated_at
string<date-time>
contact
object | null

Who to ring at this place (Phase 449b). An address gets a van to a car park; a name and a number get an animal out of it. Either half may be empty; both empty reads back as null. Only rewritten when the key is sent, so a patch about a date never clears a number somebody finally got hold of. An unknown field is refused rather than dropped.