Skip to main content
POST
Invite a shared user

Overview

Adds a new user to your account by sending them an invitation email. The user will receive an email invitation to join your account with the specified role and permissions.

Purpose

User Invitation

  • Invite Team Members: Add colleagues to your account
  • Role Assignment: Assign appropriate access levels
  • Email Invitations: Send automated invitation emails
  • Access Control: Control what users can do

Account Management

  • Team Collaboration: Enable team access to QR codes
  • Permission Management: Assign specific roles and permissions
  • User Onboarding: Streamline user addition process
  • Access Auditing: Track who has access to what

Request Body (Form Data)

Access Level Options

Default Roles

  • Manager (ID: 1): Can create, edit, and manage QR codes
  • Admin (ID: 2): Full access including user management
  • Viewer (ID: 3): Read-only access to QR codes and analytics

Custom Roles

  • Custom IDs: Use custom role IDs created in your account
  • Specific Permissions: Custom roles with tailored permissions
  • Flexible Access: Create roles for specific use cases

Examples

Add User with Manager Role

Add User with Admin Role

Add User with Viewer Role

Add User with Custom Role

Response

Success Response (201 Created)

Invitation Process

Email Invitation

  1. Invitation Sent: User receives email invitation
  2. Account Creation: User creates account or logs in
  3. Invitation Acceptance: User accepts invitation
  4. Access Granted: User gains access to your account

Invitation Status

  • is_invitation_sent: true: Invitation email has been sent
  • is_invitation_accepted: false: User hasn’t accepted yet
  • invitation_sent_on: Timestamp when invitation was sent
  • invitation_accepted_on: null: Will be set when user accepts

Integration Examples

JavaScript - Add User Form

Python - Bulk User Addition

PHP - User Invitation Form

Error Handling

Common Errors

Invalid Email Format

Missing Required Fields

Invalid Access Level

User Already Exists

Best Practices

User Management

  • Validate Email: Ensure email addresses are valid
  • Choose Appropriate Roles: Assign roles based on user needs
  • Monitor Invitations: Track invitation acceptance
  • Regular Audits: Review user access regularly

Security

  • Principle of Least Privilege: Give users minimum required access
  • Regular Reviews: Periodically review user permissions
  • Remove Inactive Users: Remove users who no longer need access
  • Monitor Activity: Track user activity and access patterns

Communication

  • Clear Instructions: Provide clear instructions to invited users
  • Follow Up: Follow up on pending invitations
  • Documentation: Document user roles and permissions
  • Training: Provide training on account features
When you add a user, they will receive an email invitation to join your account. The user must accept the invitation before they can access your account.
Make sure to assign appropriate roles to users. Admin users have full access to your account including the ability to add and remove other users.
You can add users with custom roles by using the custom role ID instead of the default role IDs (1, 2, 3). Use the Get User Roles endpoint to see available custom roles.

Authorizations

Authorization
string
header
required

Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.

Body

application/json
email
string<email>
required
name
string
required
Maximum string length: 20
access_level
integer
required

Role ID from GET /multi-users/access-levels/.

tags
integer[]
enable_tag_permission
boolean
default:false
include_untagged
boolean
default:true

Response

201 - application/json

Invitation created — sends an invitation email to the shared user.