Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Locations > Location

Creates a Location

Creates a Location

post/api/2026-07-01/resources/locations/locations

Request body

namestring required

name of the location

countrystring required

country code of the location

mainboolean

whether the location is the main one

citystring

City of the location

statestring

State of the location

phone_numberstring

phone number of the location

postal_codestring

Postal code of the location

address_line_onestring

Address line 1 of the location

address_line_twostring

Address line 2 of the location

latitudenumber

latitude of the location

longitudenumber

longitude of the location

timezonestring required

timezone of the location

radiusnumber

radius of the location

company_idstring required

company identifier

siretstring

siret of the location (only for France)

Example request

{
  "name": "Barcelona Office",
  "country": "es",
  "city": "Barcelona",
  "state": "Barcelona",
  "phone_number": "657483987",
  "postal_code": "08005",
  "address_line_one": "Carrer Mallorca",
  "address_line_two": "61 2A",
  "latitude": 52.378,
  "longitude": 4.898,
  "timezone": "Europe/Madrid",
  "radius": 5,
  "company_id": "1",
  "siret": "FR00123456789"
}

Response

CREATED

idstring required

identifier of the location

company_idstring required

company identifier

namestring required

name of the location

timezonestring

timezone of the location

countrystring

country code of the location

statestring

State of the location

citystring

City of the location

address_line_1string

Address line 1 of the location

address_line_2string

Address line 2 of the location

postal_codestring

Postal code of the location

phone_numberstring

phone number of the location

mainboolean required

whether the location is the main one

latitudenumber

latitude of the location

longitudenumber

longitude of the location

radiusnumber

radius of the location

siretstring

siret of the location (only for France)

Example response

{
  "id": "1",
  "company_id": "1",
  "name": "Barcelona Office",
  "timezone": "Europe/Madrid",
  "country": "es",
  "state": "Barcelona",
  "city": "Barcelona",
  "address_line_1": "Carrer Mallorca",
  "address_line_2": "61 2A",
  "postal_code": "08005",
  "phone_number": "657483987",
  "latitude": 52.378,
  "longitude": 4.898,
  "radius": 5,
  "siret": "FR00123456789"
}