Skip to content
API reference/
API Reference
/
/
Update a Location

Update a Location

Request

Update an existing location.

Security
apiKeyAuth and practiceGroupId
Path
idstringrequired
Bodyapplication/jsonrequired
namestring
aboutstring or null
emailstring or null, (email)
phone_numberstring or null
map_urlstring or null, (uri)
latitudenumber or null
longitudenumber or null
no_availability_textstring or null
addressobject or null
curl -i -X PATCH \
  'https://developer.herohealth.net/_mock/apis/public-api/openapi/v1/locations/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -H 'x-practice-group-id: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "about": "string",
    "email": "user@example.com",
    "phone_number": "string",
    "map_url": "http://example.com",
    "latitude": 0,
    "longitude": 0,
    "no_availability_text": "string",
    "address": {
      "line_1": "string",
      "line_2": "string",
      "line_3": "string",
      "town": "string",
      "county": "string",
      "postcode": "string"
    }
  }'

Responses

Ok

Bodyapplication/json
idstringrequired
namestringrequired
partner_site_namestring or nullrequired
aboutstring or nullrequired
emailstring or nullrequired
phone_numberstring or nullrequired
map_urlstring or nullrequired
latitudestring or nullrequired
longitudestring or nullrequired
no_availability_textstring or nullrequired
addressobject or nullrequired
archived_atstring or null, (date-time)required
created_atstring or null, (date-time)required
updated_atstring or null, (date-time)required
Response
{
  "id": "string",
  "name": "string",
  "partner_site_name": "string",
  "about": "string",
  "email": "string",
  "phone_number": "string",
  "map_url": "string",
  "latitude": "string",
  "longitude": "string",
  "no_availability_text": "string",
  "address": {
    "line_1": "string",
    "line_2": "string",
    "line_3": "string",
    "town": "string",
    "county": "string",
    "postcode": "string"
  },
  "archived_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}