Partially update point of interest

patch

https://api.sensos.io/v1/accounts/{accountId}/points-of-interest/{pointOfInterestId}

Partial update. Fields you omit are left unchanged; a field sent as explicit null is cleared. Send nested objects in full. Returns the updated point of interest.

name, type and location can't be set to null (400).
Built-in points of interest can't be updated.
A point of interest that doesn't exist in the account, or is built-in, returns 400 (not 404).

Path Params

accountId

string

required

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

pointOfInterestId

string

required

ID of the point of interest.

Body Params

Fields to update.

Request data for a partial update of a point of interest.

name

string

length ≤ 40

^[^\$\%\^\*\{\}\@]*$

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

description

string | null

Description of the point of interest.

referenceId

string | null

Your own reference ID for the point of interest.

type

string

enum

Type of the point of interest. Can't be set to null.

location

object

Location of the point of interest. Can't be set to null.

200Success

400Invalid request, name/type/location set to null, or the point of interest was not found in the account or is built-in.