Create patient tag

Request

Create a new tag on the patient. Color must be one of the allowed palette values; defaults to #C1E4FF if omitted.

Security

PartnerApiKey and PartnerOAuth

Path

patientIdinteger, (int64)required

Patient ID (AccountPatient id)

accountIdinteger, (int64)required

Account identifier

Bodyapplication/jsonrequired

colorstring, [ 0 .. 10 ] characters

Tag color as a hex code from the Lobbie palette. Defaults to #C1E4FF if omitted. Allowed values: #C1E4FF, #FFF5C4, #F7D8D8, #FAE6E6, #FFCBBA, #DFF8B6, #CBEBD7, #DDF2E5, #FFED8B, #D4DAFF, #FFBABA, #F3EAF6, #B4F595, #DFCCFC.

Example:"#C1E4FF"

notestring, [ 0 .. 1000 ] charactersrequired

Tag text

Example:"VIP"

curl -i -X POST \
  'https://api-docs.lobbie.com/_mock/openapi/partner/v2/account/{accountId}/patient/{patientId}/tag' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "color": "#C1E4FF",
    "note": "VIP"
  }'

Responses

Tag created successfully

Bodyapplication/json

activeboolean

Whether the tag is active. false indicates a removed tag.

Example:true

colorstring

Tag color (hex code from the Lobbie palette)

Example:"#C1E4FF"

createdAtstring, (date-time)

When the tag was created

Example:"2025-01-15T14:00:00Z"

idinteger, (int64)

Unique tag identifier

Example:55

notestring

Tag text

Example:"VIP"

patientIdinteger, (int64)

Patient ID this tag belongs to

Example:12345

sortOrderinteger, (int64)

Display order (ascending)

Example:10000

updatedAtstring, (date-time)

When the tag was last updated

Example:"2025-01-15T14:00:00Z"

Response

{
  "active": true,
  "color": "#C1E4FF",
  "createdAt": "2025-01-15T14:00:00Z",
  "id": 55,
  "note": "VIP",
  "patientId": 12345,
  "sortOrder": 10000,
  "updatedAt": "2025-01-15T14:00:00Z"
}