Skip to main content

Create new client user​

Create new client user for specific healthcare provider. Healthcare provider user has to exist in Upheal. Response includes session link that can be used to connect to an online session. Supports setting default note templates directly during creation.

Request Body required
  • therapistUserId string required

    A user id of therapist (healthcare provider or org admin role) that the client will belong to. Therapist user has to exist on Upheal backend.

  • partnerUserId string

    A user id in partner's system. Optional. Upheal will use this id if specified for user identification.

  • firstName string required

    User first name.

  • lastName string required

    User last name.

  • email string

    Possible values: non-empty

    client email address

  • locale string

    Client locale. Optional.

  • pronoun string

    Possible values: [MasculineHim, FeminineHer, NeutralThem]

    Optional client pronoun. It is used to improve quality of generated insights.

  • defaultNoteTemplateIds string[]

    Optional list of default note template ids for the client. These templates will be used for sessions with this client.

  • dateOfBirth string

    Optional client date of birth. ISO 8601 date format.

Responses

User created

Schema
  • userId string required

    Id of created user.

  • clientSessionUrl url required

    Unique url link client user can use to join an online session with their therapist.

  • therapistSessionUrl url required

    Unique url link therapist can use to join an online session with the client user.

  • partnerUserId string

    Optional user id in partner's system. Upheal will use this id, if specified, for user identification.

  • defaultNoteTemplateIds string[]

    List of default note template ids for the client.

  • organizationId string

    The organization ID the user belongs to.

Loading...