Skip to main content

Create new provider user v2​

Create new user and prepare an app invite the user can use to sign up.

Request Body required
  • partnerUserId string

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

  • firstName string required

    User first name.

  • lastName string required

    User last name.

  • email email required

    Possible values: non-empty

    client email address

  • phoneNumber string

    User's phone number

  • phoneCountryCode string

    User's phone country code

  • locale string

    Client locale. Optional.

  • defaultNoteTemplateIds string[]

    Optional list of default note template ids for the user.

  • nationalProviderIdentifier string

    Optional National Provider Identifier (NPI) number.

  • therapyLicence string

    Optional therapy license number.

  • noteIdentifier string

    Possible values: [Therapist, Clinician, Coach, FirstName, DrLastName, Provider, Physician, Practitioner, Author, Writer, Counselor, Psychologist, PeerSupportSpecialist, CaseManager, Supervisor, Dietitian]

    Optional note identifier for how the provider is referred to in generated notes.

Responses

User created.

Schema
  • userId string required

    Id of created user.

  • inviteUrl url required

    Unique url link user can use to sign up.

  • privateRoomLink string required

    Private room link owned by the provider, usable by provider and all clients.

  • partnerUserId string

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

  • defaultNoteTemplateIds string[]

    Optional list of default note template ids for the user.

  • organizationId string

    The organization ID the user belongs to.

  • noteIdentifier string

    Possible values: [Therapist, Clinician, Coach, FirstName, DrLastName, Provider, Physician, Practitioner, Author, Writer, Counselor, Psychologist, PeerSupportSpecialist, CaseManager, Supervisor, Dietitian]

    Note identifier for how the provider is referred to in generated notes.

Loading...