Skip to main content
PUT
/
tenant
/
update
Update Tenant
curl --request PUT \
  --url https://api.decodahealth.com/tenant/update \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "name": "<string>",
  "passFeeToPatient": true,
  "defaultTimezone": "<string>",
  "homePage": "<string>",
  "logoUrl": "<string>",
  "successfulPaymentText": "<string>",
  "hidePatientPaymentPlans": true,
  "ccEmail": "<string>",
  "replyToEmail": "<string>",
  "requiredPatientFields": [
    "first_name",
    "phone_number"
  ],
  "maxInvoicesPerDay": 100,
  "maxInvoicesPerMinute": 123,
  "invoicingStartTime": 123,
  "invoicingEndTime": 123,
  "invoicingOnWeekends": true,
  "invoicingExcludesHolidays": true,
  "sendReceiptText": "<string>",
  "autoRespondToSms": true,
  "generateResponseOnSms": true,
  "manualInvoiceText": "<string>",
  "billAutomatically": false,
  "selfSchedulingRedirectUrl": "<string>",
  "allowMultipleBookingsForDifferentAppointments": false,
  "daysUntilPatientBecomesNew": 123,
  "introductoryText": "<string>",
  "optOutMessage": "<string>",
  "helpMessage": "<string>",
  "apiKey": "<string>",
  "auditSmsResponse": true,
  "itemSortType": "USAGE",
  "reservationCancellationSmsTemplate": "<string>",
  "receiptLogoUrl": "<string>",
  "automaticallySendReceipts": true,
  "defaultReceiptCommunicationMethod": "<string>",
  "googleTagManagerId": "<string>",
  "authTimeoutMs": 123
}
'
import requests

url = "https://api.decodahealth.com/tenant/update"

payload = {
    "name": "<string>",
    "passFeeToPatient": True,
    "defaultTimezone": "<string>",
    "homePage": "<string>",
    "logoUrl": "<string>",
    "successfulPaymentText": "<string>",
    "hidePatientPaymentPlans": True,
    "ccEmail": "<string>",
    "replyToEmail": "<string>",
    "requiredPatientFields": ["first_name", "phone_number"],
    "maxInvoicesPerDay": 100,
    "maxInvoicesPerMinute": 123,
    "invoicingStartTime": 123,
    "invoicingEndTime": 123,
    "invoicingOnWeekends": True,
    "invoicingExcludesHolidays": True,
    "sendReceiptText": "<string>",
    "autoRespondToSms": True,
    "generateResponseOnSms": True,
    "manualInvoiceText": "<string>",
    "billAutomatically": False,
    "selfSchedulingRedirectUrl": "<string>",
    "allowMultipleBookingsForDifferentAppointments": False,
    "daysUntilPatientBecomesNew": 123,
    "introductoryText": "<string>",
    "optOutMessage": "<string>",
    "helpMessage": "<string>",
    "apiKey": "<string>",
    "auditSmsResponse": True,
    "itemSortType": "USAGE",
    "reservationCancellationSmsTemplate": "<string>",
    "receiptLogoUrl": "<string>",
    "automaticallySendReceipts": True,
    "defaultReceiptCommunicationMethod": "<string>",
    "googleTagManagerId": "<string>",
    "authTimeoutMs": 123
}
headers = {
    "TENANT": "<tenant>",
    "API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {TENANT: '<tenant>', 'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    passFeeToPatient: true,
    defaultTimezone: '<string>',
    homePage: '<string>',
    logoUrl: '<string>',
    successfulPaymentText: '<string>',
    hidePatientPaymentPlans: true,
    ccEmail: '<string>',
    replyToEmail: '<string>',
    requiredPatientFields: ['first_name', 'phone_number'],
    maxInvoicesPerDay: 100,
    maxInvoicesPerMinute: 123,
    invoicingStartTime: 123,
    invoicingEndTime: 123,
    invoicingOnWeekends: true,
    invoicingExcludesHolidays: true,
    sendReceiptText: '<string>',
    autoRespondToSms: true,
    generateResponseOnSms: true,
    manualInvoiceText: '<string>',
    billAutomatically: false,
    selfSchedulingRedirectUrl: '<string>',
    allowMultipleBookingsForDifferentAppointments: false,
    daysUntilPatientBecomesNew: 123,
    introductoryText: '<string>',
    optOutMessage: '<string>',
    helpMessage: '<string>',
    apiKey: '<string>',
    auditSmsResponse: true,
    itemSortType: 'USAGE',
    reservationCancellationSmsTemplate: '<string>',
    receiptLogoUrl: '<string>',
    automaticallySendReceipts: true,
    defaultReceiptCommunicationMethod: '<string>',
    googleTagManagerId: '<string>',
    authTimeoutMs: 123
  })
};

fetch('https://api.decodahealth.com/tenant/update', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.decodahealth.com/tenant/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'passFeeToPatient' => true,
    'defaultTimezone' => '<string>',
    'homePage' => '<string>',
    'logoUrl' => '<string>',
    'successfulPaymentText' => '<string>',
    'hidePatientPaymentPlans' => true,
    'ccEmail' => '<string>',
    'replyToEmail' => '<string>',
    'requiredPatientFields' => [
        'first_name',
        'phone_number'
    ],
    'maxInvoicesPerDay' => 100,
    'maxInvoicesPerMinute' => 123,
    'invoicingStartTime' => 123,
    'invoicingEndTime' => 123,
    'invoicingOnWeekends' => true,
    'invoicingExcludesHolidays' => true,
    'sendReceiptText' => '<string>',
    'autoRespondToSms' => true,
    'generateResponseOnSms' => true,
    'manualInvoiceText' => '<string>',
    'billAutomatically' => false,
    'selfSchedulingRedirectUrl' => '<string>',
    'allowMultipleBookingsForDifferentAppointments' => false,
    'daysUntilPatientBecomesNew' => 123,
    'introductoryText' => '<string>',
    'optOutMessage' => '<string>',
    'helpMessage' => '<string>',
    'apiKey' => '<string>',
    'auditSmsResponse' => true,
    'itemSortType' => 'USAGE',
    'reservationCancellationSmsTemplate' => '<string>',
    'receiptLogoUrl' => '<string>',
    'automaticallySendReceipts' => true,
    'defaultReceiptCommunicationMethod' => '<string>',
    'googleTagManagerId' => '<string>',
    'authTimeoutMs' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "API-KEY: <api-key>",
    "Content-Type: application/json",
    "TENANT: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.decodahealth.com/tenant/update"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"passFeeToPatient\": true,\n  \"defaultTimezone\": \"<string>\",\n  \"homePage\": \"<string>\",\n  \"logoUrl\": \"<string>\",\n  \"successfulPaymentText\": \"<string>\",\n  \"hidePatientPaymentPlans\": true,\n  \"ccEmail\": \"<string>\",\n  \"replyToEmail\": \"<string>\",\n  \"requiredPatientFields\": [\n    \"first_name\",\n    \"phone_number\"\n  ],\n  \"maxInvoicesPerDay\": 100,\n  \"maxInvoicesPerMinute\": 123,\n  \"invoicingStartTime\": 123,\n  \"invoicingEndTime\": 123,\n  \"invoicingOnWeekends\": true,\n  \"invoicingExcludesHolidays\": true,\n  \"sendReceiptText\": \"<string>\",\n  \"autoRespondToSms\": true,\n  \"generateResponseOnSms\": true,\n  \"manualInvoiceText\": \"<string>\",\n  \"billAutomatically\": false,\n  \"selfSchedulingRedirectUrl\": \"<string>\",\n  \"allowMultipleBookingsForDifferentAppointments\": false,\n  \"daysUntilPatientBecomesNew\": 123,\n  \"introductoryText\": \"<string>\",\n  \"optOutMessage\": \"<string>\",\n  \"helpMessage\": \"<string>\",\n  \"apiKey\": \"<string>\",\n  \"auditSmsResponse\": true,\n  \"itemSortType\": \"USAGE\",\n  \"reservationCancellationSmsTemplate\": \"<string>\",\n  \"receiptLogoUrl\": \"<string>\",\n  \"automaticallySendReceipts\": true,\n  \"defaultReceiptCommunicationMethod\": \"<string>\",\n  \"googleTagManagerId\": \"<string>\",\n  \"authTimeoutMs\": 123\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("TENANT", "<tenant>")
	req.Header.Add("API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://api.decodahealth.com/tenant/update")
  .header("TENANT", "<tenant>")
  .header("API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"passFeeToPatient\": true,\n  \"defaultTimezone\": \"<string>\",\n  \"homePage\": \"<string>\",\n  \"logoUrl\": \"<string>\",\n  \"successfulPaymentText\": \"<string>\",\n  \"hidePatientPaymentPlans\": true,\n  \"ccEmail\": \"<string>\",\n  \"replyToEmail\": \"<string>\",\n  \"requiredPatientFields\": [\n    \"first_name\",\n    \"phone_number\"\n  ],\n  \"maxInvoicesPerDay\": 100,\n  \"maxInvoicesPerMinute\": 123,\n  \"invoicingStartTime\": 123,\n  \"invoicingEndTime\": 123,\n  \"invoicingOnWeekends\": true,\n  \"invoicingExcludesHolidays\": true,\n  \"sendReceiptText\": \"<string>\",\n  \"autoRespondToSms\": true,\n  \"generateResponseOnSms\": true,\n  \"manualInvoiceText\": \"<string>\",\n  \"billAutomatically\": false,\n  \"selfSchedulingRedirectUrl\": \"<string>\",\n  \"allowMultipleBookingsForDifferentAppointments\": false,\n  \"daysUntilPatientBecomesNew\": 123,\n  \"introductoryText\": \"<string>\",\n  \"optOutMessage\": \"<string>\",\n  \"helpMessage\": \"<string>\",\n  \"apiKey\": \"<string>\",\n  \"auditSmsResponse\": true,\n  \"itemSortType\": \"USAGE\",\n  \"reservationCancellationSmsTemplate\": \"<string>\",\n  \"receiptLogoUrl\": \"<string>\",\n  \"automaticallySendReceipts\": true,\n  \"defaultReceiptCommunicationMethod\": \"<string>\",\n  \"googleTagManagerId\": \"<string>\",\n  \"authTimeoutMs\": 123\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.decodahealth.com/tenant/update")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["TENANT"] = '<tenant>'
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"passFeeToPatient\": true,\n  \"defaultTimezone\": \"<string>\",\n  \"homePage\": \"<string>\",\n  \"logoUrl\": \"<string>\",\n  \"successfulPaymentText\": \"<string>\",\n  \"hidePatientPaymentPlans\": true,\n  \"ccEmail\": \"<string>\",\n  \"replyToEmail\": \"<string>\",\n  \"requiredPatientFields\": [\n    \"first_name\",\n    \"phone_number\"\n  ],\n  \"maxInvoicesPerDay\": 100,\n  \"maxInvoicesPerMinute\": 123,\n  \"invoicingStartTime\": 123,\n  \"invoicingEndTime\": 123,\n  \"invoicingOnWeekends\": true,\n  \"invoicingExcludesHolidays\": true,\n  \"sendReceiptText\": \"<string>\",\n  \"autoRespondToSms\": true,\n  \"generateResponseOnSms\": true,\n  \"manualInvoiceText\": \"<string>\",\n  \"billAutomatically\": false,\n  \"selfSchedulingRedirectUrl\": \"<string>\",\n  \"allowMultipleBookingsForDifferentAppointments\": false,\n  \"daysUntilPatientBecomesNew\": 123,\n  \"introductoryText\": \"<string>\",\n  \"optOutMessage\": \"<string>\",\n  \"helpMessage\": \"<string>\",\n  \"apiKey\": \"<string>\",\n  \"auditSmsResponse\": true,\n  \"itemSortType\": \"USAGE\",\n  \"reservationCancellationSmsTemplate\": \"<string>\",\n  \"receiptLogoUrl\": \"<string>\",\n  \"automaticallySendReceipts\": true,\n  \"defaultReceiptCommunicationMethod\": \"<string>\",\n  \"googleTagManagerId\": \"<string>\",\n  \"authTimeoutMs\": 123\n}"

response = http.request(request)
puts response.read_body
{
  "name": "<string>",
  "subDomain": "<string>",
  "providerDeactivatedPages": [
    "<string>"
  ],
  "patientDeactivatedPages": [
    "<string>"
  ],
  "enabledModules": [],
  "homePage": "<string>",
  "passFeeToPatient": true,
  "paymentProcessor": "<string>",
  "activatedChargeMethods": [
    "<string>"
  ],
  "phoneNumber": "<string>",
  "logoUrl": "<string>",
  "successfulPaymentText": "<string>",
  "campaign": "<string>",
  "enterpriseTenant": "<string>",
  "manualInvoiceText": "<string>",
  "sendReceiptText": "<string>",
  "clinicType": "DEFAULT",
  "practiceTypeCode": 123,
  "slogan": "<string>",
  "replyToEmail": "<string>",
  "ccEmail": "<string>",
  "defaultTimezone": "<string>",
  "hidePatientPaymentPlans": false,
  "coloredMail": false,
  "requiredPatientFields": [],
  "enabledCommunicationMethods": [],
  "enabledInvoiceMethods": [
    "EMAIL",
    "SMS",
    "CHARGE_CARD"
  ],
  "maxInvoicesPerDay": 100,
  "invoicingStartTime": 9,
  "invoicingEndTime": 17,
  "invoicingOnWeekends": false,
  "invoicingExcludesHolidays": false,
  "maxInvoicesPerMinute": 10,
  "autoRespondToSms": false,
  "generateResponseOnSms": false,
  "billAutomatically": false,
  "selfSchedulingRedirectUrl": "<string>",
  "allowMultipleBookingsForDifferentAppointments": false,
  "allowMultipleSelfScheduleAppointments": false,
  "daysUntilPatientBecomesNew": 123,
  "authTimeoutMs": 123,
  "introductoryText": "<string>",
  "optOutMessage": "<string>",
  "helpMessage": "<string>",
  "apiKey": "<string>",
  "gcalEmail": "<string>",
  "gcalToken": "<string>",
  "gcalRefreshToken": "<string>",
  "auditSmsResponse": false,
  "itemSortType": "USAGE",
  "reservationCancellationSmsTemplate": "<string>",
  "automaticallySendReceipts": true,
  "defaultReceiptCommunicationMethod": "SMS",
  "receiptLogoUrl": "<string>",
  "duplicatePatientFields": [
    "first_name",
    "last_name",
    "phone_number"
  ],
  "googleTagManagerId": "<string>"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Body

application/json

Update a tenant.

​
name
string | null
​
passFeeToPatient
boolean | null
​
defaultTimezone
string | null
​
homePage
string | null
​
logoUrl
string | null
​
successfulPaymentText
string | null
​
hidePatientPaymentPlans
boolean | null
​
ccEmail
string | null
​
replyToEmail
string | null
​
requiredPatientFields
string[] | null
​
maxInvoicesPerDay
integer
default:100
​
maxInvoicesPerMinute
integer | null
​
invoicingStartTime
integer | null
​
invoicingEndTime
integer | null
​
invoicingOnWeekends
boolean | null
​
invoicingExcludesHolidays
boolean | null
​
sendReceiptText
string | null
​
autoRespondToSms
boolean | null
​
generateResponseOnSms
boolean | null
​
manualInvoiceText
string | null
​
billAutomatically
boolean
default:false
​
selfSchedulingRedirectUrl
string | null
​
allowMultipleBookingsForDifferentAppointments
boolean
default:false
​
daysUntilPatientBecomesNew
integer | null
​
introductoryText
string | null
​
optOutMessage
string | null
​
helpMessage
string | null
​
apiKey
string | null
​
auditSmsResponse
boolean | null
default:true
​
itemSortType
enum<string>
default:USAGE
Available options:
CATEGORY,
USAGE,
DEFINED_ORDER,
NAME,
PRICE
​
reservationCancellationSmsTemplate
string | null
​
receiptLogoUrl
string | null
​
automaticallySendReceipts
boolean | null
​
defaultReceiptCommunicationMethod
string | null
​
googleTagManagerId
string | null
​
authTimeoutMs
integer | null

Response

Successful Response

The configuration for each of the clients of Decoda.

​
name
string
required
​
subDomain
string
required
​
providerDeactivatedPages
string[]
required
​
patientDeactivatedPages
string[]
required
​
enabledModules
enum<string>[]
required
Available options:
TEXTING,
CALLING,
PAYMENTS,
SCRIBE,
SCHEDULING,
FORMS,
INVENTORY,
LOCATIONS,
CALENDAR_PATIENT_STATUS,
SPAKINECT,
SCRIBE_MEDICAL_CODES
​
homePage
string
required
​
passFeeToPatient
boolean
required
​
paymentProcessor
string
required
​
activatedChargeMethods
string[]
required
​
phoneNumber
string
required
​
logoUrl
string
required
​
successfulPaymentText
string
required
​
campaign
string
required
​
enterpriseTenant
string | null
required
​
manualInvoiceText
string
required
​
sendReceiptText
string
required
​
smsProvider
enum<string>
required
Available options:
SIGNALWIRE,
SENDO
​
clinicType
enum<string>
default:DEFAULT
Available options:
DEFAULT,
WEIGHT_LOSS,
MED_SPA
​
practiceTypeCode
integer | null
​
slogan
string | null
​
replyToEmail
string | null
​
ccEmail
string | null
​
defaultTimezone
string | null
​
hidePatientPaymentPlans
boolean
default:false
​
coloredMail
boolean
default:false
​
requiredPatientFields
string[]
​
enabledCommunicationMethods
enum<string>[]
Available options:
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
​
enabledInvoiceMethods
enum<string>[]

The method used to send an invoice to a patient.

Available options:
CHARGE_CARD,
SMS,
EMAIL,
CALL,
MAIL,
EXPIRY
​
maxInvoicesPerDay
integer
default:100
​
invoicingStartTime
integer
default:9
​
invoicingEndTime
integer
default:17
​
invoicingOnWeekends
boolean
default:false
​
invoicingExcludesHolidays
boolean
default:false
​
maxInvoicesPerMinute
integer
default:10
​
autoRespondToSms
boolean
default:false
​
generateResponseOnSms
boolean
default:false
​
billAutomatically
boolean
default:false
​
selfSchedulingRedirectUrl
string | null
​
allowMultipleBookingsForDifferentAppointments
boolean
default:false
​
allowMultipleSelfScheduleAppointments
boolean
default:false
​
daysUntilPatientBecomesNew
integer | null
​
authTimeoutMs
integer | null
​
introductoryText
string | null
​
optOutMessage
string | null
​
helpMessage
string | null
​
apiKey
string | null
​
gcalEmail
string | null
​
gcalToken
string | null
​
gcalRefreshToken
string | null
​
auditSmsResponse
boolean
default:false
​
itemSortType
enum<string>
default:USAGE
Available options:
CATEGORY,
USAGE,
DEFINED_ORDER,
NAME,
PRICE
​
reservationCancellationSmsTemplate
string | null
​
automaticallySendReceipts
boolean
default:true
​
defaultReceiptCommunicationMethod
enum<string>
default:SMS
Available options:
SMS,
MAIL,
CALL,
COLLECTIONS,
EMAIL,
SMS_AND_EMAIL
​
receiptLogoUrl
string | null
​
duplicatePatientFields
string[]
​
googleTagManagerId
string | null