Update a user

UserUpdateResponse AutoScribe.Users.Update(, )

PATCH/v1/autoScribe/users/{userId}

Updates a user's profile information, permissions, and AutoScribe-specific settings. All fields are optional - only provided fields will be updated. Email cannot be changed via API. NPI number is required if enabling report creation capability.

ParametersExpand Collapse

UserUpdateParams parameters

required string userID

Unique user identifier. Format: usr_{32-hex-chars}

Boolean canCreateReports

Boolean canManageStudies

ClinicRole? clinicRole

string firstName

User's first name

minLength1

Boolean hasDashboardAccess

Whether the user can access the dashboard interface. Required for admin users

string lastName

User's last name

minLength1

Level level

string? middleName

minLength1

string? npiNumber

minLength10

maxLength10

string? phoneNumber

string? suffix1

minLength1

string? suffix2

minLength1

ReturnsExpand Collapse

class UserUpdateResponse:

A user in the AutoScribe system with report creation permissions

required Boolean CanCreateReports

Whether the user can generate and sign radiology reports. Requires NPI number

required Boolean CanManageStudies

Whether the user has permission to create, update, and manage studies

required ClinicRole ClinicRole

User's clinical or organizational role

Accepts one of the following:

required DateTimeOffset? CreatedAt

Timestamp when the user was created

formatdate-time

required string Email

User's email address for login and notifications

required string FirstName

User's first name

minLength1

required Boolean HasDashboardAccess

Whether the user can access the dashboard interface. Required for admin users

required InvitedSource InvitedSource

How the user was invited - via dashboard UI or API

Accepts one of the following:

required DateTimeOffset? LastLoginAt

Timestamp of user's last login, null if never logged in

formatdate-time

required string LastName

User's last name

minLength1

required Level Level

User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access

Accepts one of the following:

required string UserID

Unique user identifier. Format: usr_{32-hex-chars}

string MiddleName

User's middle name (optional)

minLength1

string NpiNumber

National Provider Identifier - required for users who can create reports (10-digit number)

minLength10

maxLength10

string PhoneNumber

User's phone number (10-15 digits, optional)

string Suffix1

Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional

minLength1

string Suffix2

Additional name suffix (optional)

minLength1

Update a user

UserUpdateParams parameters = new()
{
    UserID = "usr_1234567890abcdef1234567890abcdef"
};

var user = await client.AutoScribe.Users.Update(parameters);

Console.WriteLine(user);

{
  "canCreateReports": true,
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "npiNumber": "1234567893",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}

Returns Examples

{
  "canCreateReports": true,
  "canManageStudies": true,
  "clinicRole": "Radiologist",
  "createdAt": "2024-01-15T10:00:00Z",
  "email": "dr.johnson@hospital.org",
  "firstName": "Sarah",
  "hasDashboardAccess": true,
  "invitedSource": "api",
  "lastLoginAt": "2024-03-15T09:00:00Z",
  "lastName": "Johnson",
  "level": "member",
  "userId": "usr_1234567890abcdef1234567890abcdef",
  "middleName": "Marie",
  "npiNumber": "1234567893",
  "phoneNumber": "5551234567",
  "suffix1": "MD",
  "suffix2": "FACR"
}