Skip to main content
PATCH
/
billing
/
tip-displays
/
{display_id}
Update Tip Display
curl --request PATCH \
  --url https://api.decodahealth.com/billing/tip-displays/{display_id} \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "name": "<string>",
  "isActive": true
}
'
{
  "id": "<string>",
  "name": "<string>",
  "locationId": "<string>",
  "isActive": true,
  "createdDate": "2023-11-07T05:31:56Z"
}

Headers

​
TENANT
string
required

The tenant you are making this request on behalf of

​
API-KEY
string
required

Your api key

Path Parameters

​
display_id
string
required

Body

application/json

Request to update a tip display.

​
name
string | null

New display name

​
isActive
boolean | null

Whether display is active

Response

Successful Response

A configured tip display.

​
id
string
required

Display ID

​
name
string
required

Display name (e.g. 'Front Desk')

​
locationId
string
required

Location ID

​
isActive
boolean
required

Whether display is active

​
createdDate
string<date-time>
required

Creation time