Skip to main content
POST
/
user
/
event-icons
Create Event Icon
curl --request POST \
  --url https://api.decodahealth.com/user/event-icons \
  --header 'API-KEY: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TENANT: <tenant>' \
  --data '
{
  "iconType": "BOOKING_FEE_PAID",
  "emoji": "<string>",
  "color": "<string>",
  "isActive": true
}
'
{
  "id": "<string>",
  "iconType": "BOOKING_FEE_PAID",
  "emoji": "<string>",
  "color": "<string>",
  "isActive": true,
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "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

Body

application/json
​
iconType
enum<string>
required

Type of event icon

Available options:
BOOKING_FEE_PAID,
NEW_PATIENT,
SCHEDULED_BY_AI,
FORM_COMPLETED,
CHECKED_IN
​
emoji
string
required

Emoji for the icon

Maximum string length: 10
​
color
string
required

Color code for the icon (hex format)

Maximum string length: 7
​
isActive
boolean
default:true

Whether the icon is active

Response

Successful Response

​
id
string
required

Unique identifier for the event icon

​
iconType
enum<string>
required

Type of event icon

Available options:
BOOKING_FEE_PAID,
NEW_PATIENT,
SCHEDULED_BY_AI,
FORM_COMPLETED,
CHECKED_IN
​
emoji
string
required

Emoji for the icon

​
color
string
required

Color code for the icon (hex format)

​
isActive
boolean
required

Whether the icon is active

​
createdDate
string<date-time>
required

Date and time when the icon was created

​
updatedDate
string<date-time> | null

Date and time when the icon was last updated