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

Name of the patient tag

Required string length: 1 - 100
​
emoji
string | null

Emoji associated with the tag

Maximum string length: 10
​
color
string | null

Color code for the tag (hex format)

Maximum string length: 7
​
isActive
boolean
default:true

Whether the tag is active

Response

Successful Response

​
id
string
required

Unique identifier for the patient tag

​
name
string
required

Name of the patient tag

​
isActive
boolean
required

Whether the tag is active

​
createdDate
string<date-time>
required

Date and time when the tag was created

​
emoji
string | null

Emoji associated with the tag

​
color
string | null

Color code for the tag (hex format)

​
updatedDate
string<date-time> | null

Date and time when the tag was last updated