Account Settings: Wallet, Profile, and API Keys
The top-right header is the account chrome on every logged-in page: wallet, notifications, WhatsApp number expiry, and the profile menu. This guide is what those controls open.
Profile dropdown items come from your tenant’s profile menu (role / permissions). You see the items your account is allowed to use. Labels can vary. This is portal chrome — not a public HTTP API.
Agents see a reduced header (no Go Back; wallet may be hidden).
Header tour
Left
| Control | What it does |
|---|---|
| Logo | Home / dashboard (agents stay put) |
| Menu (hamburger) | Collapse / open the sidebar |
| Go Back | Browser-style back (hidden for Agent accounts) |
| Now | Live clock |
| Expiry pill | WhatsApp number plan expiry. Lists numbers, plan, end date, days left. Renew starts gateway recharge |
Right (the profile cluster)
| Control | What it does |
|---|---|
| Wallet | Current balance in the selected currency; dropdown lists all wallet currencies |
| Bell | In-app notifications; View More opens the notifications list |
| Avatar + name | Profile menu (items depend on role) + Logout |
Wallet
- Shows Available balance for the selected currency (flag + amount).
- Open the dropdown to switch currency if the account has more than one wallet.
- Empty state: No balances.
Full wallet screen: My Wallet / Transactions (/system/wallet-history).
| Tool | What you do |
|---|---|
| Transactions | Search, filter, export wallet history |
| Recharge Wallet | Add credits (if the account is allowed to recharge) |
| Refresh | Reload balances |
Credits here pay SMS, WhatsApp, RCS, fallback hops, and inbox replies. Low balance is the most common send failure. Check this header before you open a ticket about a failed campaign.
Notifications
- Badge = unread count.
- Dropdown lists recent alerts.
- View More → notifications page (
system/notifications/ broadcast notifications, depending on tenant). - Inside User Profile → Notifications, choose which alerts you receive.
WhatsApp number expiry
If a connected WhatsApp number’s subscription / plan is ending:
- The header shows an expiry warning.
- Expand to see mobile number, plan, end date, days left.
- Renew opens recharge for that number.
This is not the same as wallet credits. You can have SMS balance and still fail WhatsApp because the number plan ended. Renew from the pill, or see Subscriptions.
Profile dropdown
Always present:
- Account header: username + account type (User / Reseller / Team / Agent / Account Manager, and similar)
- Dynamic links from profile menu
- Logout
Typical items (you may see a subset):
| Menu item | Opens | What it is |
|---|---|---|
| Profile | User Profile / Edit profile | Name, mobile, email, entity, avatar, services, default currency |
| My Wallet | Wallet history | Transactions and recharge |
| Team | Team management | Roles and team users (not inbox agents) |
| Get Widgets | WhatsApp chat widget | Embed a click-to-chat button on a website |
| Self Whitelabel | White-label brands | Logo, domain, branding (Reseller / Super Admin) |
| Login History | Login history | Who signed in, when, from where |
| API Key | Developer API keys | Keys for SMS / WhatsApp / RCS HTTP APIs (sometimes under System → Developer instead) |
| Logout | Sign out | Ends the session |
If an item is missing, the role does not include that profile-menu entry.
User Profile
Route: /system/edit-user-profile (and /system/user-profile/:userId).
Sidebar tabs (each can be hidden by permission):
| Tab | What you do |
|---|---|
| Profile Settings | Avatar, username, personal / entity details, assigned services, default currency |
| Preferences | Default currency, extra wallet currencies, service pricing alignment |
| Authentication | Two-step login: OTP and/or Google Authenticator |
| Notifications | Which in-app / email alerts to receive |
| Security | Change password |
| Delete Account | Request account deletion |
| Documents | Upload KYC / business documents |
Keep profile, password, and 2FA up to date. API keys and wallet live nearby in the same header cluster.
Team vs Inbox agents
/system/team-management
| Screen | What it is |
|---|---|
| Roles | Permission packs for team members |
| Team users | People who log in under this account |
This is portal team access, not Team Inbox agents. Inbox agents are created under Team Inbox → Agent list. Portal Team users open the dashboard; inbox agents pick chats.
Related (if the role has it): Agent config and Agent analytics.
Get Widgets
/whatsapp-app/getWidgets
Embed a WhatsApp live-chat button on your site (no coding required). Chats still land in Team Inbox.
| Setting | Meaning |
|---|---|
| WhatsApp Number | Connected business number |
| Widget Button Name | Optional, max 15 characters |
| Position | Left or right |
| Theme color | Button colour |
| Brand Name | Max 15 characters |
| Brand Subtitle | Max 40 characters |
| Brand Image URL | Logo |
| Welcome Message | Max 200 characters |
Copy the generated snippet onto the website. Pick the same WhatsApp number the inbox is watching, or chats open on a different thread.
API keys
/system/apikey — also System → Developer → API Key on many accounts.
| Tool | What you do |
|---|---|
| Generate API Key | Create a key with a title |
| IP allowlist | Restrict which servers can call the APIs |
| Priority | Queue priority for sends |
| Rotate / disable / delete | Govern keys |
| Read API Docs | Opens this Developers document |
This is the same apikey header used on SMS /v1/sms, WhatsApp /v1/whatsapp, and RCS /v1/rcs. See Authentication. Treat the key like a password; do not put it in a website widget or a mobile app.
Self Whitelabel
/system/self-whitelable (Reseller / Super Admin).
Brand library: add / activate brands (logo, look and feel, domain). Customers of a reseller see that brand in the header logo instead of the default Omni logo.
Login History
/system/login-history
Audit table: search / filter login and logout times (and related session details). Use it to spot unexpected access. Pair with Authentication (OTP / Google Authenticator) on the profile.
Subscriptions
If the tenant has Subscription in the menu (/subscription/...):
| Screen | What it is |
|---|---|
| My subscription | Current plan |
| Plans | Available plans |
| Billing | Invoices / payment |
| Usage | Consumption |
| Success | Post-payment confirmation |
WhatsApp number expiry in the header is related: renewing a number plan is different from recharging the wallet. You often need both — plan for the number, wallet for each message.
Logout
Always the last item in the profile menu. After logout you must sign in again. Unsaved compose screens are lost.
How these tools connect
- Wallet (header) funds SMS, WhatsApp, RCS, fallback hops, and inbox replies.
- Fallback is selected on compose; it does not send by itself.
- Profile → API Key is how developers send without the portal.
- Get Widgets + Team Inbox = website visitors chatting on WhatsApp.
- Expiry pill + Subscription / Renew keep WhatsApp numbers live.
- Login History + Authentication keep the account safe.
Typical issues
| Area | Situation |
|---|---|
| Fallback | Rule created but not selected on compose — Fallback |
| Fallback | Backup channel has no credits / unapproved template |
| Wallet | Send fails with insufficient credit — check the header balance |
| Profile | Missing menu item — role does not include that profile-menu entry |
| 2FA | Login blocked until OTP / authenticator is completed |
| Widgets | Wrong WhatsApp number selected — chats go to another inbox |
| Expiry | WhatsApp number plan ended — Renew from the header pill |
Next: Fallback to chain channels, Authentication for the apikey header, Team Inbox for widget chats.