Skip to main content

Update provider user by id v2​

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

Path Parameters
  • providerUserId string required

    The provider user's internal Upheal UUID or the partner's partnerUserId (external ID) set during user creation. Note - using partnerUserId may result in slightly higher latency due to an additional lookup.

Request Body required
  • 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

Provider user updated.

Schema
  • userId string required

    Id of the user.

  • firstName string required

    User first name.

  • lastName string required

    User last name.

  • email string required

    Client email address.

  • defaultNoteTemplateIds string[] required

    Optional list of default note template ids for the user.

  • nationalProviderIdentifier string

    Optional National Provider Identifier (NPI) number.

  • therapyLicence string

    Optional therapy license number.

  • partnerUserId string

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

  • phoneNumber string

    User's phone number (without country code)

  • phoneCountryCode string

    User's phone country code

  • 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]

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

Loading...