Skip to main content

Update user by id​

Update user's attributes. All request fields are optional. Deactivated users cannot be updated.

Path Parameters
  • userId string required
Request Body required
  • firstName string

    User first name.

  • lastName string

    User last name.

  • pronoun string

    Possible values: [MasculineHim, FeminineHer, NeutralThem]

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

  • dateOfBirth string

    Optional client date of birth. ISO 8601 date format.

Responses

User updated.

Schema
  • userId string

    Id of of the user.

  • firstName string

    User first name.

  • lastName string

    User last name.

  • email string

    client email address

  • userType string

    Type of user - Client, HealthcareProvider or OrgAdmin

  • phoneNumber string

    User's phone number (without country code)

  • phoneCountryCode string

    User's phone country code

  • inviteUrl url

    Unique url link user can use to sign up.

  • privateRoomLink string

    Private room link owned by the provider usable by all clients (UI requires client selection).

  • clientSessionUrl url

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

  • therapistSessionUrl url

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

  • pronoun string

    Possible values: [MasculineHim, FeminineHer, NeutralThem]

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

  • partnerUserId string

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

  • dateOfBirth string

    Optional client date of birth. ISO 8601 date format.

  • organizationId string

    The organization ID the user belongs to.

  • defaultSessionType string

    Default session type for the client. Possible values are Standard, Intake, Soap, Dap, Girp, Birp, Emdr.

Loading...