Skip to main content
PATCH
Update a place

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Path Parameters

id
string
required

Place id.

Example:

"p1q2r3"

Body

application/json

Place fields. Unknown fields are refused with 400. On update only the fields sent change.

name
string
address
string

Geocoded in the background on create when no location is given.

email
string
phone
string
city
string
postalCode
string
state
string
countryCode
string
color
string
teams
integer[]

Team numbers. On create, without teams the place goes to the creator's teams.

radius
integer

Check-in radius in meters.

location
object
extendedData
object

Custom fields. Merged into the place's current fields: names sent get the value (stored as text), names sent as null are removed, names not sent stay.

Response

Success

data
object
required
error
null
required
meta
object
required