Skip to content

Update ​

PATCH

/:tenantId

Body ​

json
{
    "name": "Mock Clinic",
    "city": "New York",
    "district": "Manhattan",
    "address": "123 Broadway St, New York, NY 10001",
    "mobile": "+1234567890",
    "phone": "+0987654321",
    "email": "info@mockclinic.com",
    "lat": 40.712776,
    "lng": -74.005974,
    "logo": null,
    "timezone": "America/New_York",
    "default_currency": "USD",
    "currencies": [
      "USD",
      "EUR"
    ],
    "require_confirmation_on_calendar": true,
    "patient_quick_create_fields": ["mobile", "identity_number"],
    "sector_id": "1",
    "tax_office": "Manhattan",
    "tax_number": "1234567890",
    "is_uss_free": false
  }
FieldTypeRequiredDescription
namestringNoThe name of the clinic.
citystringNoThe city where the clinic is located.
districtstringNoThe district within the city where the clinic is located.
addressstringNoThe full address of the clinic.
mobilestringNoThe mobile phone number of the clinic, including country code.
phonestringNoAn alternate phone number for the clinic, including country code.
emailstringNoThe email address for the clinic, used for general communication.
latfloatNoLatitude between -90 and 90.
lngfloatNoLongitude between -180 and 180.
logostringNoA URL pointing to the clinic's logo. (base64-encoded)
timezonestringNoThe timezone of the clinic (e.g., "America/New_York").
default_currencystringNoThe default currency used by the clinic (e.g., "USD").
currenciesarray of stringsNoA list of currencies supported by the clinic (["USD", "EUR", "GBP", "TRY", "TZS"]).
require_confirmation_on_calendarbooleanNoIndicates whether confirmation is required for calendar actions (true or false).
patient_quick_create_fieldsarray of stringsNoFields displayed during quick patient creation.
sector_idstringNoExisting sector identifier.
tax_officestringNoClinic tax office.
tax_numberstringNoClinic tax number.
is_uss_freebooleanNoIndicates whether the tenant uses the free USS mode.
migrated_atdatetimeNoMigration timestamp (YYYY-MM-DD HH:mm); accepted only for an authenticated migration request.
migration_sourcestringNoMigration source; accepted only for an authenticated migration request.

Response ​

HTTP 200 OK

json
{
  "data": {
    "name": "Mock Clinic",
    "city": "New York",
    "district": "Manhattan",
    "address": "123 Broadway St, New York, NY 10001",
    "mobile": null,
    "phone": null,
    "email": "info@mockclinic.com",
    "contact_name": "Miss Lenora Langosh",
    "contact_email": "nelle.bayer@example.com",
    "contact_phone": "+19063296179",
    "lat": 40.712776,
    "lng": -74.005974,
    "logo": null,
    "timezone": "Europe/Istanbul",
    "account_type": 1,
    "is_license_expired": false,
    "license_expires_at": "2026-04-16T13:30:16.000000Z",
    "default_currency": "USD",
    "currencies": [
      "USD",
      "EUR"
    ],
    "require_confirmation_on_calendar": true,
    "patient_quick_create_fields": [
      {"name": "mobile"},
      {"name": "identity_number"}
    ],
    "tax_office": "Manhattan",
    "tax_number": "1234567890",
    "user_limit": 10,
    "user_count": 4,
    "is_uss_free": false,
    "product_type": 1,
    "product_type_name": "KYS",
    "sector_id": "1",
    "migration_source": null,
    "gift_sms": 0,
    "has_gift_sms_license": false
  }
}