Create point of interest

Create a new point of interest for an account. The location is a circle (geoCircle); address is filled in from its coordinates when omitted. Returns 201 with the new point of interest; the Location header holds its ID.

Path Params
string
required

ID of the account. An account you don't have access to returns 403.

Body Params

Point of interest to create.

Request data for a point of interest.

string
required
length ≤ 40
^[^\$\%\^\*\{\}\@]*$

Name of the point of interest. Can't contain $ % ^ * { } @.

string | null

Description of the point of interest.

string | null

Your own reference ID for the point of interest.

string
enum
required

Type of the point of interest.

location
object
required

Location of the point of interest. When address is omitted it is filled in from the circle's coordinates; coordinates that can't be resolved to an address return 400.

tags
array of strings | null, unique

Tags. Up to 15 tags of up to 30 characters each.

tags
contactInfo
object

Contact details for the point of interest.

operationalHours
object

Weekly opening hours. Periods within a day must not overlap. Omit a day, or send an empty array, when the location is closed that day.

Responses

401

Missing, invalid or expired access token. Returned by the gateway with an empty body.

403

The token lacks the required permission, the account is not accessible to the caller, or the tenant is inactive. Returned by the gateway with an empty body.

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