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

Clinics API (1.0)

Web service that stores information about clinics, clinicians and their patients

Download OpenAPI description
clinic.v1.json
clinic.v1.yaml
Overview
URL

https://www.tidepool.org

Tidepool

support@tidepool.org

License

BSD-2-Clause

Languages
Servers
Mock server

https://tidepool.redocly.app/_mock/reference/clinic.v1/

integration

https://external.integration.tidepool.org/

production

https://api.tidepool.org/

dev1

https://dev1.dev.tidepool.org/

qa1

https://qa1.development.tidepool.org/

qa2

https://qa2.development.tidepool.org/

Clinics

Manage clinics, clinians and patients.

Operations

Delete Patient

Request

Deletes patient from a clinic. Requires the request to be made by a clinic admin or the currently authenticated user id to match the patient id.

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
patientIdstring^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...required
curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patients/{patientId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

No Content

Update Patient Tag

Request

Update existing patient tag

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
patientTagIdstring^[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 PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patient_tags/{patientTagId}' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string"
  }'

Responses

The updated patient tag

Bodyapplication/json
idstring(Object Id)= 24 characters^[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

Response
application/json
{
  "id": "stringstringstringstring",
  "name": "string"
}

Delete Patient Tag

Request

Removes a patient tag from a clinic and tagged patients

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
patientTagIdstring^[a-f0-9]{24}$required
curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/patient_tags/{patientTagId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

No content

Confirmations

Manage confirmations for account creation, sharing invites, etc.

Operations

Internal

APIs intended for internal use by Tidepool.

Operations

Redox

Public endpoints invoked by Redox.

Operations