# Users ## Invite **post** `/v1/autoScribe/users` Creates a new user in the AutoScribe system and sends them an invitation email. The user will have the specified permissions including report creation and study management capabilities. NPI number is required for users who can create reports. ### Body Parameters - `canCreateReports: boolean` - `canManageStudies: boolean` - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` - `lastName: string` User's last name - `level: "admin" or "member"` - `"admin"` - `"member"` - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Returns - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "admin" or "member"` User access level. 'admin' can manage users/settings, 'member' has standard access - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "canCreateReports": true, "canManageStudies": true, "clinicRole": "Radiologist", "email": "dr.johnson@hospital.org", "firstName": "Sarah", "hasDashboardAccess": true, "lastName": "Johnson", "level": "member", "middleName": "Marie", "npiNumber": "1234567893", "phoneNumber": "5551234567", "suffix1": "MD", "suffix2": "FACR" }' ``` ## List **get** `/v1/autoScribe/users` Retrieves a paginated list of users with optional filtering by access level, email, name, invitation source, and report creation capability. Returns up to 100 users per request. ### Query Parameters - `canCreateReports: optional boolean` Filter by canCreateReports permission (AutoScribe-specific) - `cursor: optional string` Base64 encoded cursor from previous response - `email: optional string` Filter by exact email match - `firstName: optional string` Filter by first name (contains match) - `invitedSource: optional "dashboard" or "api"` Filter by invitation source - `"dashboard"` - `"api"` - `lastName: optional string` Filter by last name (contains match) - `level: optional "owner" or "admin" or "member"` Filter by user level - `"owner"` - `"admin"` - `"member"` - `limit: optional number` Number of results to return (1-100) ### Returns - `hasMore: boolean` - `users: array of object { canCreateReports, canManageStudies, clinicRole, 14 more }` - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "owner" or "admin" or "member"` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"` - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) - `cursor: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Retrieve **get** `/v1/autoScribe/users/{userId}` Retrieves a single user by their unique user ID. Returns the complete user object with all profile information, permissions, AutoScribe-specific settings, and status. ### Path Parameters - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} ### Returns - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "owner" or "admin" or "member"` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"` - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/$USER_ID \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## 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. ### Path Parameters - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} ### Body Parameters - `canCreateReports: optional boolean` - `canManageStudies: optional boolean` - `clinicRole: optional "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `firstName: optional string` User's first name - `hasDashboardAccess: optional boolean` Whether the user can access the dashboard interface. Required for admin users - `lastName: optional string` User's last name - `level: optional "admin" or "member"` - `"admin"` - `"member"` - `middleName: optional string` - `npiNumber: optional string` - `phoneNumber: optional string` - `suffix1: optional string` - `suffix2: optional string` ### Returns - `canCreateReports: boolean` Whether the user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the user has permission to create, update, and manage studies - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` User's clinical or organizational role - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the user was created - `email: string` User's email address for login and notifications - `firstName: string` User's first name - `hasDashboardAccess: boolean` Whether the user can access the dashboard interface. Required for admin users - `invitedSource: "dashboard" or "api"` How the user was invited - via dashboard UI or API - `"dashboard"` - `"api"` - `lastLoginAt: string` Timestamp of user's last login, null if never logged in - `lastName: string` User's last name - `level: "owner" or "admin" or "member"` User access level. 'owner' has full control, 'admin' can manage users/settings, 'member' has standard access - `"owner"` - `"admin"` - `"member"` - `userId: string` Unique user identifier. Format: usr_{32-hex-chars} - `middleName: optional string` User's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` User's phone number (10-15 digits, optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'Sr.', 'III') - optional - `suffix2: optional string` Additional name suffix (optional) ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/$USER_ID \ -X PATCH \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Revoke Access **post** `/v1/autoScribe/users/revoke-access` Deactivates a user's access to the system. The user will no longer be able to log in, create reports, or access studies. User data is preserved and can be reactivated later. ### Body Parameters - `userId: string` User ID to revoke access for. Format: usr_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/revoke-access \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "userId": "usr_1234567890abcdef1234567890abcdef" }' ``` ## Reactivate **post** `/v1/autoScribe/users/reactivate` Restores access for a previously deactivated user. The user will regain their original permissions including report creation and study management capabilities. ### Body Parameters - `userId: string` User ID to reactivate. Format: usr_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/reactivate \ -H 'Content-Type: application/json' \ -H "Authorization: Bearer $AVARA_API_KEY" \ -d '{ "userId": "usr_1234567890abcdef1234567890abcdef" }' ``` # Invitations ## List **get** `/v1/autoScribe/users/invitations` Retrieves a paginated list of user invitations with optional filtering by status, expiration, date range, and user ID. Returns up to 100 invitations per request. ### Query Parameters - `cursor: optional string` Base64 encoded cursor from previous response - `endDate: optional string` Filter invitations created on or before this date (YYYY-MM-DD) - `expired: optional "all" or "expired" or "not-expired"` Filter by expiration status - `"all"` - `"expired"` - `"not-expired"` - `limit: optional number` Number of results to return (1-100) - `startDate: optional string` Filter invitations created on or after this date (YYYY-MM-DD) - `status: optional array of "sent" or "accepted" or "rejected" or "revoked"` Filter by invitation status(es) - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `userId: optional string` Filter by user ID. Format: usr_{32-hex-chars} ### Returns - `hasMore: boolean` - `invitations: array of object { canCreateReports, canManageStudies, clinicId, 20 more }` - `canCreateReports: boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicId: string` UUID of the clinic this invitation belongs to - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` Clinical or organizational role for the invited user - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the invitation was created - `email: string` Email address the invitation was sent to - `expiry: string` When the invitation expires, null if no expiration - `firstName: string` Invited user's first name - `hasDashboardAccess: boolean` Whether the invited user will have dashboard access - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} - `invitedSource: "dashboard" or "api"` How the invitation was created - 'dashboard' or 'api' - `"dashboard"` - `"api"` - `inviterId: string` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `lastName: string` Invited user's last name - `level: "owner" or "admin" or "member"` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"` - `"admin"` - `"member"` - `status: "sent" or "accepted" or "rejected" or "revoked"` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `updatedAt: string` Timestamp when the invitation was last updated - `userId: string` Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user's permanent ID upon acceptance - `invitedByApiKeyId: optional string` UUID of the API key used to send this invitation. Null if sent via dashboard - `middleName: optional string` Invited user's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` Invited user's phone number (optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'MD') - optional - `suffix2: optional string` Additional name suffix - optional - `cursor: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Retrieve **get** `/v1/autoScribe/users/invitations/{invitationId}` Retrieves a single invitation by its unique invitation ID. Returns the complete invitation details including status, expiration, associated user information, and AutoScribe-specific permissions. ### Path Parameters - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} ### Returns - `canCreateReports: boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicId: string` UUID of the clinic this invitation belongs to - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` Clinical or organizational role for the invited user - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the invitation was created - `email: string` Email address the invitation was sent to - `expiry: string` When the invitation expires, null if no expiration - `firstName: string` Invited user's first name - `hasDashboardAccess: boolean` Whether the invited user will have dashboard access - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} - `invitedSource: "dashboard" or "api"` How the invitation was created - 'dashboard' or 'api' - `"dashboard"` - `"api"` - `inviterId: string` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `lastName: string` Invited user's last name - `level: "owner" or "admin" or "member"` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"` - `"admin"` - `"member"` - `status: "sent" or "accepted" or "rejected" or "revoked"` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `updatedAt: string` Timestamp when the invitation was last updated - `userId: string` Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user's permanent ID upon acceptance - `invitedByApiKeyId: optional string` UUID of the API key used to send this invitation. Null if sent via dashboard - `middleName: optional string` Invited user's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` Invited user's phone number (optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'MD') - optional - `suffix2: optional string` Additional name suffix - optional ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations/$INVITATION_ID \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Update **patch** `/v1/autoScribe/users/invitations/{invitationId}` Updates a pending invitation's user details, permissions, and AutoScribe-specific settings before it is accepted. Only valid for invitations that have not expired or been processed. NPI number is required if enabling report creation. ### Path Parameters - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} ### Body Parameters - `canCreateReports: optional boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: optional boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicRole: optional "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `firstName: optional string` Invited user's first name - `hasDashboardAccess: optional boolean` Whether the invited user will have dashboard access - `lastName: optional string` Invited user's last name - `level: optional "admin" or "member"` - `"admin"` - `"member"` - `middleName: optional string` - `npiNumber: optional string` - `phoneNumber: optional string` - `suffix1: optional string` - `suffix2: optional string` ### Returns - `canCreateReports: boolean` Whether the invited user can generate and sign radiology reports. Requires NPI number - `canManageStudies: boolean` Whether the invited user will have permission to create, update, and manage studies - `clinicId: string` UUID of the clinic this invitation belongs to - `clinicRole: "Radiologist" or "Cardiologist" or "Neurologist" or 18 more` Clinical or organizational role for the invited user - `"Radiologist"` - `"Cardiologist"` - `"Neurologist"` - `"Urologist"` - `"Gynecologist"` - `"Endocrinologist"` - `"Doctor"` - `"Surgeon"` - `"Physician"` - `"Physician Assistant"` - `"Nurse Practitioner"` - `"Registered Nurse"` - `"Patient Care Coordinator"` - `"Front Desk Operator"` - `"Imaging Technologist"` - `"PACS Administrator"` - `"Software Engineer"` - `"Revenue Cycle Manager"` - `"Administrative Director"` - `"Administrative Assistant"` - `"Other"` - `createdAt: string` Timestamp when the invitation was created - `email: string` Email address the invitation was sent to - `expiry: string` When the invitation expires, null if no expiration - `firstName: string` Invited user's first name - `hasDashboardAccess: boolean` Whether the invited user will have dashboard access - `invitationId: string` Unique invitation identifier. Format: inv_{32-hex-chars} - `invitedSource: "dashboard" or "api"` How the invitation was created - 'dashboard' or 'api' - `"dashboard"` - `"api"` - `inviterId: string` User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API - `lastName: string` Invited user's last name - `level: "owner" or "admin" or "member"` Access level for the invited user. 'admin' or 'member' when created via API - `"owner"` - `"admin"` - `"member"` - `status: "sent" or "accepted" or "rejected" or "revoked"` Invitation status: 'sent', 'accepted', 'rejected', or 'revoked' - `"sent"` - `"accepted"` - `"rejected"` - `"revoked"` - `updatedAt: string` Timestamp when the invitation was last updated - `userId: string` Pre-generated user ID for this invitation. Format: usr_{32-hex-chars}. This ID is assigned at invitation creation and will become the user's permanent ID upon acceptance - `invitedByApiKeyId: optional string` UUID of the API key used to send this invitation. Null if sent via dashboard - `middleName: optional string` Invited user's middle name (optional) - `npiNumber: optional string` National Provider Identifier - required for users who can create reports (10-digit number) - `phoneNumber: optional string` Invited user's phone number (optional) - `suffix1: optional string` Name suffix (e.g., 'Jr.', 'MD') - optional - `suffix2: optional string` Additional name suffix - optional ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations/$INVITATION_ID \ -X PATCH \ -H "Authorization: Bearer $AVARA_API_KEY" ``` ## Revoke **post** `/v1/autoScribe/users/invitations/revoke` Revokes a pending invitation, preventing it from being accepted. Can revoke by invitation ID, user ID, or both. Useful for cancelling invitations sent in error. ### Body Parameters - `invitationId: optional string` Invitation ID to revoke. Format: inv_{32-hex-chars} - `userId: optional string` User ID whose pending invitation to revoke. Format: usr_{32-hex-chars} ### Returns - `success: boolean` - `message: optional string` ### Example ```http curl https://api.avarasoftware.com/v1/autoScribe/users/invitations/revoke \ -X POST \ -H "Authorization: Bearer $AVARA_API_KEY" ```