Skip to content
Tidepool API/Clinics API/
/
Create Patient Tag

Create Patient Tag

Request

Create a new patient tag

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
namestring, [ 1 .. 20 ] characters^[\p{L}\p{N}_+><-]{1}[\p{L}\p{N}\s_+><-]*$required

The tag display name

curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patient_tags' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string"
  }'

Responses

The newly-created patient tag

Bodyapplication/json
idstring, = 24 characters(Object Id)^[a-f0-9]{24}$read-onlyrequired

String representation of a resource id

namestring, [ 1 .. 20 ] characters^[\p{L}\p{N}_+><-]{1}[\p{L}\p{N}\s_+><-]*$required

The tag display name

numPatientsintegerread-only
Response
{
  "id": "stringstringstringstring",
  "name": "string",
  "numPatients": 0
}