Skip to content

Accept Clinician Invite

Request

Accept an invite to join a clinic as clinician. The clinician will be associated to the currently authenticated user if the email in their profile matches the email of the invite.

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

inviteIdstring, non-emptyrequired
curl -i -X PUT \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinicians/{userId}/invites/{inviteId}' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(Tidepool User ID)^([0-9a-f]{10}|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-...read-only

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

inviteIdstring

The id of the invite if it hasn't been accepted

emailstring, (email)required
namestring, non-empty

The name of the clinician

rolesArray of strings, non-empty, unique(Clinician Permissions)required
Items Enum:"CLINIC_ADMIN""CLINIC_MEMBER""PRESCRIBER"
createdTimestring, (date-time)read-onlyrequired
updatedTimestring, (date-time)read-onlyrequired
Response
{ "id": "string", "inviteId": "string", "email": "user@example.com", "name": "string", "roles": [ "CLINIC_ADMIN" ], "createdTime": "2019-08-24T14:15:22Z", "updatedTime": "2019-08-24T14:15:22Z" }