tenant

Update Tenant

put/tenant/update

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

namestring nullable
passFeeToPatientboolean nullable
defaultTimezonestring nullable
homePagestring nullable
logoUrlstring nullable
successfulPaymentTextstring nullable
hidePatientPaymentPlansboolean nullable
ccEmailstring nullable
replyToEmailstring nullable
requiredPatientFieldsstring[] nullable
maxInvoicesPerDayinteger
maxInvoicesPerMinuteinteger nullable
invoicingStartTimeinteger nullable
invoicingEndTimeinteger nullable
invoicingOnWeekendsboolean nullable
invoicingExcludesHolidaysboolean nullable
sendReceiptTextstring nullable
autoRespondToSmsboolean nullable
generateResponseOnSmsboolean nullable
manualInvoiceTextstring nullable
billAutomaticallyboolean
selfSchedulingRedirectUrlstring nullable
allowMultipleBookingsForDifferentAppointmentsboolean
daysUntilPatientBecomesNewinteger nullable
introductoryTextstring nullable
optOutMessagestring nullable
helpMessagestring nullable
apiKeystring nullable
auditSmsResponseboolean nullable
itemSortType'CATEGORY' | 'USAGE' | 'DEFINED_ORDER' | 'NAME' | 'PRICE'
reservationCancellationSmsTemplatestring nullable
receiptLogoUrlstring nullable
automaticallySendReceiptsboolean nullable
defaultReceiptCommunicationMethodstring nullable
googleTagManagerIdstring nullable
authTimeoutMsinteger nullable

Response

Successful Response

namestring required
subDomainstring required
clinicType'DEFAULT' | 'WEIGHT_LOSS' | 'MED_SPA'
providerDeactivatedPagesstring[] required
patientDeactivatedPagesstring[] required
enabledModulesModule[] required
homePagestring required
passFeeToPatientboolean required
paymentProcessorstring required
activatedChargeMethodsstring[] required
phoneNumberstring required
logoUrlstring required
successfulPaymentTextstring required
campaignstring required
enterpriseTenantstring nullable required
manualInvoiceTextstring required
practiceTypeCodeinteger nullable
sloganstring nullable
replyToEmailstring nullable
ccEmailstring nullable
defaultTimezonestring nullable
hidePatientPaymentPlansboolean
coloredMailboolean
requiredPatientFieldsstring[]
enabledCommunicationMethodsCommunicationMethod[]
enabledInvoiceMethodsInvoiceMethod[]
maxInvoicesPerDayinteger
invoicingStartTimeinteger
invoicingEndTimeinteger
invoicingOnWeekendsboolean
invoicingExcludesHolidaysboolean
maxInvoicesPerMinuteinteger
sendReceiptTextstring required
autoRespondToSmsboolean
generateResponseOnSmsboolean
billAutomaticallyboolean
smsProvider'SIGNALWIRE' | 'SENDO' required
selfSchedulingRedirectUrlstring nullable
allowMultipleBookingsForDifferentAppointmentsboolean
allowMultipleSelfScheduleAppointmentsboolean
daysUntilPatientBecomesNewinteger nullable
authTimeoutMsinteger nullable
introductoryTextstring nullable
optOutMessagestring nullable
helpMessagestring nullable
apiKeystring nullable
gcalEmailstring nullable
gcalTokenstring nullable
gcalRefreshTokenstring nullable
auditSmsResponseboolean
itemSortType'CATEGORY' | 'USAGE' | 'DEFINED_ORDER' | 'NAME' | 'PRICE'
reservationCancellationSmsTemplatestring nullable
automaticallySendReceiptsboolean
defaultReceiptCommunicationMethod'SMS' | 'MAIL' | 'CALL' | 'COLLECTIONS' | 'EMAIL' | 'SMS_AND_EMAIL'
receiptLogoUrlstring nullable
duplicatePatientFieldsstring[]
googleTagManagerIdstring nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.