Skip to content
Tidepool API/Clinics API/
/
Remove User from Clinics

Remove User from Clinics

Request

Internal endpoint that deletes any user associations with clinics they are a patient or a member of.

If the user is a patient of a clinic the service will delete the patient-clinic relationship.

If the user is one of many admins of any clinic the service will delete the clinician-clinic relationship.

If the user is the only admin of a clinic the service will:

  • delete the clinician record, leaving the clinic without an admin
  • delete all non-custodial patient relationships of the clinic
  • keep all custodian relationships, allowing users to claim custodial accounts with an email
  • keep all custodian accounts and data even if they can’t be claimed when there isn’t an email address associated with the account
Security
sessionToken
Path
userIdstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-onlyrequired

String representation of a Tidepool User ID. Old style IDs are 10-digit strings consisting of only hexadeximcal digits. New style IDs are 36-digit UUID v4

curl -i -X DELETE \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/users/{userId}/clinics' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK