Skip to main content
PUT
Changes a clinic’s details. Send name and email every time. The other fields are optional: a field you leave out keeps its current value. Requires a partner key whose creator is the partner account owner or a Tenant Admin. See Authentication.
This endpoint refuses to update a clinic that has ever had a subscription, a plan from your partner account, or a purchased phone number. It returns 409 with "code": "ORG_HAS_SUBSCRIPTION_HISTORY" and changes nothing. The message in that response talks about deletion, but it is returned for updates. To change such a clinic, edit it in the dashboard: in your partner account, open Organizations, then the clinic’s actions menu (⋮), then Modify.

Headers

string
required
Bearer followed by your partner key, for example Bearer sk-….
string
required
application/json

Path parameters

string
required
The clinic’s organization ID, a UUID. See Finding IDs.

Body

string
required
Clinic name, 3 to 50 characters.
string
required
Clinic email address. Must be a valid email address.
string
Street address, up to 255 characters.
string
City, up to 255 characters.
string
State or province, up to 255 characters.
string
Postal or ZIP code, up to 255 characters.
string
Country, up to 255 characters.
string
Clinic contact number, up to 255 characters.
string
IANA time zone name, for example America/Toronto. Only letters, _ and / are accepted.
Any other field in the body is ignored. You can’t change externalId, the owner or the partner account here.

Response

Returns 200 with the updated clinic.
string
The clinic’s organization ID (UUID).
string
Your partner account’s ID.
string
Clinic name.
string
Clinic email address.
string
ID of the clinic’s owner.
string
Street address.
string
City.
string
State or province.
string
Postal or ZIP code.
string
Country.
string
Clinic contact number.
string
Time zone name.
boolean
true.
string
ID of the person who created the clinic.
string
When the clinic was created, ISO 8601 in UTC.
The response doesn’t include updatedAt. It may include other fields not listed here; don’t build on them.

Errors

The billing-history check runs before the body is validated, so a clinic with billing history always gets 409, even for an invalid body. See Errors for the full list.