# Send Invitation to Join Care Team

Sends an invitation to join the care team of the user identified by .

Endpoint: POST /confirm/send/invite/{userId}
Version: 1.0
Security: sessionToken

## Path parameters:

  - `userId` (string, required)
    Tidepool User ID

## Request fields (application/json):

  - `email` (string, required)
    An email address, as specified by [RFC 5322](https://datatracker.ietf.org/doc/html/rfc5322).
    Example: "example@tidepool.org"

  - `permissions` (object, required)
    Example: {"note":{},"upload":{},"view":{}}

  - `permissions.note` (object)
    Example: {}

  - `permissions.upload` (object)
    Example: {}

  - `permissions.view` (object)
    Example: {}

  - `nickname` (string)
    A user-friendly name for the recipient of the invitation.
    Example: "Julia"

  - `alertsConfig` (object)
    Configuration for alerts triggered in response to the status of a user's device and data.

  - `alertsConfig.urgentLow` (object)
    Blood glucose measurements at or below this value will trigger an immediate and urgent alert.

  - `alertsConfig.urgentLow.enabled` (boolean)
    A toggle for disabling the alert.

  - `alertsConfig.urgentLow.threshold` (any, required)
    Blood glucose value, in  or

  - `alertsConfig.low` (object)
    Blood glucose measurements at or below this value will trigger an alert.

  - `alertsConfig.low.delay` (integer)
    Duration in minutes to wait before alerting.

  - `alertsConfig.low.repeat` (integer)
    Duration in minutes, after which an alert will be repeated.
A value of 0 disables the repeat functionality.

  - `alertsConfig.high` (object)
    Blood glucose measurements at or above this value will trigger an alert.

  - `alertsConfig.noCommunication` (object)
    An alert sent when issues prevent the display of CGM data.

  - `alertsConfig.notLooping` (object)
    An alert sent when the Tidepool Loop app is unable to loop.

## Response 200 fields (application/json):

  - `key` (string, required)
    Example: "Sds2PHMALZrmt++JyD5mIjLkZruJldiM"

  - `type` (string, required)
    Enum: "password_reset", "careteam_invitation", "clinician_invitation", "signup_confirmation", "no_account"

  - `status` (string, required)
    Enum: "pending", "completed", "canceled", "declined"

  - `email` (string, required)
    An email address, as specified by [RFC 5322](https://datatracker.ietf.org/doc/html/rfc5322).
    Example: "example@tidepool.org"

  - `creatorId` (string, required)
    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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `created` (string, required)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `modified` (string)
    [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) / [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) timestamp _with_ timezone information
    Example: "2017-02-06T02:37:46Z"

  - `creator` (object)

  - `creator.userid` (string, required)
    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](https://en.wikipedia.org/wiki/Universally_unique_identifier#Version_4_(random))

  - `creator.profile` (object, required)

  - `creator.profile.fullName` (string, required)

  - `creator.profile.patient` (object, required)

  - `creator.profile.patient.birthday` (string)
    Example: "2012-08-30"

  - `creator.profile.patient.diagnosisDate` (string)
    Example: "2013-05-09"

  - `creator.profile.patient.isOtherPerson` (boolean)

  - `context` (string)

  - `restrictions` (object)

  - `restrictions.canAccept` (boolean, required)
    Whether the invite can be accepted by the current user

  - `restrictions.requiredIdp` (string)
    Set if the user must be authenticated against a specific identity provider before they are able to accept the invite

  - `expiresAt` (string)
    If specified, the invitation will expire at the given date and time.
    Example: "2024-01-30T08:11:00Z"

## Response 400 fields (application/json):

  - `code` (integer, required)

  - `error` (integer)

  - `reason` (string, required)

## Response 401 fields (application/json):

  - `code` (integer, required)

  - `error` (integer)

  - `reason` (string, required)

## Response 500 fields (application/json):

  - `code` (integer, required)

  - `error` (integer)

  - `reason` (string, required)