Skip to main content
Use this endpoint to activate or deactivate locations in your system. This allows you to control which locations are available for appointment scheduling and other operations.

Parameters

ParameterTypeRequiredDescription
idstringYesThe location’s ID (returned in the GET /locations response)
statusstringYesMust be either “active” or “inactive”

Example Request

curl -X PATCH https://api.usecobalt.com/v1/locations/abc123def4567890abcdef1234567890 \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-d '{
    "status": "inactive"
}'

Example Response

{
    "success": true,
    "message": "Location status updated successfully.",
    "location_id": "abc123def4567890abcdef1234567890"
}

Notes

  • The status update is case-insensitive (“active”, “Active”, “ACTIVE” are all accepted)
  • Only the status field can be updated through this endpoint
  • The location must belong to your organization
  • Invalid location IDs will return a 404 error