Workspace Management

Users & Team Management

• 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

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

Account Settings

• 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

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

• 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

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

Messaging API — Trigger Sends from Other Platforms

• POST /api/v1/send/template — sends any APPROVED template (MARKETING, UTILITY, or AUTHENTICATION) to a recipient
• Auth: X-API-Key header, using a key with the template:send scope
• Request body: to (E.164 phone), template_name, language_code, components (array mapping template variables), plus optional phone_number_id and idempotency_key
• Response (201): message_id, wa_message_id, status, and cost_credits
• idempotency_key lets your automation tool retry the same event safely without sending duplicate messages
• Billed at the template's real category rate (utility/marketing/authentication) from your credit wallet
• Per-key rate limiting (requests/hour, set when the key is created) — returns 429 with a Retry-After header if exceeded
• No native app or SDK needed — call it from a Custom HTTP Action in Zapier, Make, n8n, Pabbly, or directly from the other platform's own webhook/automation feature
• Dedicated shortcut for OTP codes: POST /api/v1/otp/send takes a code and button_index instead of raw components

curl -X POST https://<your-domain>/api/v1/send/template \
  -H "X-API-Key: <key>" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "+919876543210",
    "template_name": "order_shipped",
    "language_code": "en_US",
    "components": [
      { "type": "body", "parameters": [{ "type": "text", "text": "12345" }] }
    ]
  }'

1. 1Create (or reuse) an APPROVED template — use category UTILITY for transactional updates like order or delivery status
2. 2Go to Settings → API Keys → Create API Key and enable the template:send scope
3. 3Copy the generated key immediately — it's shown only once
4. 4In the other platform (or a connector like Zapier/Make/n8n), add an action that fires on the business event: new order, ticket closed, payment received, etc.
5. 5Configure that action as an HTTP POST to https://<your-domain>/api/v1/send/template with header X-API-Key: <your key> and Content-Type: application/json
6. 6Map the event's data into the JSON body — to, template_name, language_code, and components matching the template's variables
7. 7Trigger a real test event from the source platform and confirm the WhatsApp message arrives
8. 8Check Settings → API Keys — the key's Last Used timestamp confirms the integration is live