Skip to main content
POST
Add a location

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

The organization's ID.

Body

application/json

An address or a phone number is needed.

name
string

Such as Westbrook clinic. Cut to 120 characters; empty unless you say.

Maximum string length: 120
address
object

Every part is optional, and a key not listed here is refused. An empty or null part is removed.

phone
string | null

Kept as digits only. At most 15 digits together with the calling code.

phone_country
string | null

The calling code, one to three digits, like 1 or 44. A value that is not a calling code is refused.

notes
string | null

Cut to 2,000 characters.

Maximum string length: 2000
is_primary
boolean

true makes this the main location.

Response

The location.

id
string
required
organization_id
string
required
name
string
required
address
object
required

Every part is optional, and a key not listed here is refused. An empty or null part is removed.

phone
string | null
required
phone_country
string | null
required
is_primary
boolean
required

Whether this is the main location.

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