Create location

Create a new location. Returns the id and name of the new location.

Required permission: Locations

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the new location

string | null
required

The location's name (max 50 characters).

type
object | null
required

The location type. On writes, provide either id or code (code wins when both are set). Values come from /api/property_values/location_types/values.

string | null

The location's description (max 2,000 characters).

address
object | null

The location's address, when one is set.

boolean

Whether the location is active.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Authentication is required, or the Ocs-Api-Key header is missing or invalid.

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json