Update an invitation
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
Unique invitation identifier. Format: inv_{32-hex-chars}
Body ParametersJSON
Whether the invited user can generate and sign radiology reports. Requires NPI number
Whether the invited user will have permission to create, update, and manage studies
Invited user's first name
Whether the invited user will have dashboard access
Invited user's last name
Returns
Whether the invited user can generate and sign radiology reports. Requires NPI number
Whether the invited user will have permission to create, update, and manage studies
UUID of the clinic this invitation belongs to
Timestamp when the invitation was created
Email address the invitation was sent to
When the invitation expires, null if no expiration
Invited user's first name
Whether the invited user will have dashboard access
Unique invitation identifier. Format: inv_{32-hex-chars}
User ID of the person who sent the invitation. Format: usr_{32-hex-chars}. Null if invited via API
Invited user's last name
Timestamp when the invitation was last updated
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
UUID of the API key used to send this invitation. Null if sent via dashboard
Invited user's middle name (optional)
National Provider Identifier - required for users who can create reports (10-digit number)
Invited user's phone number (optional)
Name suffix (e.g., 'Jr.', 'MD') - optional
Additional name suffix - optional
Update an invitation
curl https://api.avarasoftware.com/v1/autoScribe/users/invitations/$INVITATION_ID \
-X PATCH \
-H "Authorization: Bearer $AVARA_API_KEY"{
"canCreateReports": true,
"canManageStudies": true,
"clinicId": "550e8400-e29b-41d4-a716-446655440000",
"clinicRole": "Radiologist",
"createdAt": "2024-03-15T10:00:00Z",
"email": "dr.chen@hospital.org",
"expiry": "2024-04-15T00:00:00Z",
"firstName": "Michael",
"hasDashboardAccess": true,
"invitationId": "inv_1234567890abcdef1234567890abcdef",
"invitedSource": "api",
"inviterId": "usr_1234567890abcdef1234567890abcdef",
"lastName": "Chen",
"level": "member",
"status": "sent",
"updatedAt": "2024-03-15T10:00:00Z",
"userId": "usr_1234567890abcdef1234567890abcdef",
"invitedByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
"middleName": "David",
"npiNumber": "1234567893",
"phoneNumber": "5551234567",
"suffix1": "MD",
"suffix2": null
}Returns Examples
{
"canCreateReports": true,
"canManageStudies": true,
"clinicId": "550e8400-e29b-41d4-a716-446655440000",
"clinicRole": "Radiologist",
"createdAt": "2024-03-15T10:00:00Z",
"email": "dr.chen@hospital.org",
"expiry": "2024-04-15T00:00:00Z",
"firstName": "Michael",
"hasDashboardAccess": true,
"invitationId": "inv_1234567890abcdef1234567890abcdef",
"invitedSource": "api",
"inviterId": "usr_1234567890abcdef1234567890abcdef",
"lastName": "Chen",
"level": "member",
"status": "sent",
"updatedAt": "2024-03-15T10:00:00Z",
"userId": "usr_1234567890abcdef1234567890abcdef",
"invitedByApiKeyId": "550e8400-e29b-41d4-a716-446655440000",
"middleName": "David",
"npiNumber": "1234567893",
"phoneNumber": "5551234567",
"suffix1": "MD",
"suffix2": null
}