Skip to main content
PATCH
/
v1
/
organisations
/
{organisationId}
/
locations
/
{locationId}
Update location
curl --request PATCH \
  --url https://api.halth.com/v1/organisations/{organisationId}/locations/{locationId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "bookingCustomText": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "timeZone": "<string>",
  "address": {
    "line1": "<string>",
    "line2": "<string>",
    "suburb": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postcode": "<string>",
    "country": "<string>",
    "countryCode": "<string>"
  },
  "suggestedTaxIdentifier": "<string>",
  "bookingCustomText": "<string>",
  "businessId": "<string>",
  "business": {
    "id": "<string>",
    "name": "<string>",
    "settings": {
      "autoReconciliationEnabled": true
    },
    "taxIdentifier": "<string>",
    "countryCode": "<string>",
    "structure": "public_corporation",
    "merchantId": "<string>",
    "capabilities": [
      {
        "id": "bookings_client_management",
        "status": "inactive"
      }
    ]
  }
}

Path Parameters

organisationId
string
required

Organisation ID

Example:

"org_31XEcUshz1ymodA14HALnyP48g1"

locationId
string
required

Body

application/json
bookingCustomText
string
Maximum string length: 500

Response

200 - application/json
id
string
required
name
string
required
createdAt
string<date-time>
required
timeZone
string
required
address
object
required
suggestedTaxIdentifier
string
bookingCustomText
string
businessId
string
business
object