Skip to content
Tidepool API/Clinics API/Confirmations

Invite Clinician

Request

Send an invite to clinician's email address to join a clinic.

Security
sessionToken
Path
clinicIdstring^[a-f0-9]{24}$required
Bodyapplication/json
emailstring, (email), >= 6 characters(Email Address)required

An email address, as specified by RFC 5322.

Example:"example@tidepool.org"
rolesArray of strings, non-empty, unique(Clinician Permissions)required
Items Enum:"CLINIC_ADMIN""CLINIC_MEMBER""PRESCRIBER"
curl -i -X POST \
  'https://tidepool.redocly.app/_mock/reference/clinic.v1/v1/clinics/{clinicId}/invites/clinicians' \
  -H 'Content-Type: application/json' \
  -H 'x-tidepool-session-token: YOUR_API_KEY_HERE' \
  -d '{
    "email": "example@tidepool.org",
    "roles": [
      "CLINIC_ADMIN"
    ]
  }'

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"
}