All docs

Workspace Management

Manage your team, organisation settings, API access, and account preferences.

Team

Users & Team Management

Invite teammates, assign roles, and manage the people in your workspace. Each invitation sends an email; existing Vaaniq users are added instantly without a new password.

Key features
  • Invite by email — sends a workspace invitation with a one-click accept link
  • Auto-detects existing Vaaniq accounts and skips password setup
  • Assign one of three roles: Admin, Agent, or Viewer
  • Edit user details, change roles, or deactivate accounts
  • Delete users with safeguards — cannot remove the last Org Admin
  • Search and filter the user list by name, email, or role
How to use
  1. 1Go to Settings → Users and click Invite User
  2. 2Enter the teammate's email address
  3. 3Select their role: Admin (full access), Agent (send messages), Viewer (read-only)
  4. 4Click Send Invite — they'll receive an email with next steps
  5. 5The new user appears in the list once they accept the invitation
TipYou must be an Org Admin to manage users. If you need to change your own role, ask another Admin to do it.

Account Settings

Update your profile name, change your password, or delete your account. Password changes require email OTP verification.

Key features
  • Update your display name shown across the platform
  • Change password — protected by an email OTP to prevent unauthorised changes
  • Email notification on password change for security awareness
  • Delete account — irreversible, requires OTP confirmation, removes all personal data
  • View your current role and organisation membership
How to use
  1. 1Click your avatar or profile icon in the top-right corner
  2. 2Select Account Settings from the dropdown
  3. 3To change your name: edit the display name field and save
  4. 4To change your password: click Change Password, enter your current password and new password
  5. 5Check your email for the OTP, enter it to confirm the change

API Keys

Generate and manage API keys for programmatic access. Keys inherit the permissions of your user role and can be revoked at any time.

Key features
  • Create named API keys for different integrations or services
  • Copy the key immediately after creation — it is shown only once
  • Delete keys instantly to revoke access
  • Each key carries the same permissions as your user role
  • Use in Authorization header: Bearer <api_key>
  • View creation date and last used timestamp for each key
How to use
  1. 1Navigate to Settings → API Keys
  2. 2Click Create API Key and enter a descriptive name (e.g., 'CRM Integration')
  3. 3Copy the generated key string and store it securely
  4. 4Use the key in API requests: header Authorization: Bearer <key>
  5. 5Delete the key from the same page if it is compromised or no longer needed
TipAPI keys are scoped to your organisation. For security, rotate keys periodically and delete unused ones.