Skip to main content
Create Location

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

select
string

Filtering Columns

Body

application/json

location

id
string<uuid>
default:random uuid

Location ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

name
string<text>

Name of the location

external_id
string<text> | null

External ID

street
string<text> | null

Street address

postal_code
string<text> | null

Postal or ZIP code

city
string<text> | null

City

region
string<text> | null

Region or state

iso_country
string<text> | null

ISO 3166-1 alpha-2 country code

address_line
string<text> | null

Full formatted address line (generated)

Response

The updated Location object

id
string<uuid>
default:random uuid

Location ID

created_at
string<timestamp with time zone>
default:now()

Creation date

updated_at
string<timestamp with time zone>
default:now()

Latest update

organisation_id
string<uuid>

Organisation ID

name
string<text>

Name of the location

external_id
string<text> | null

External ID

street
string<text> | null

Street address

postal_code
string<text> | null

Postal or ZIP code

city
string<text> | null

City

region
string<text> | null

Region or state

iso_country
string<text> | null

ISO 3166-1 alpha-2 country code

address_line
string<text> | null

Full formatted address line (generated)