Create mailboxes from HR or billing systems
The user provisioning API lets another system, such as an HRMS or billing platform, create, update, list and delete XgenPlus mailboxes. Your administrator issues an API key and allows the calling server's IP address. Ask them for the key, the API address and the field list. A new joiner's mailbox can then exist before day one.
For: Domain admin, Server adminWebTime-saving
How to create mailboxes from hr or billing systems
- Ask your administrator for an API key and to allow your server's IP address.
- Call the create operation with the new user's details when HR onboards someone.
- Call update or delete when details change or the person leaves.
- Use the list operation to reconcile your records with XgenPlus.
Example
When HR at acme.in onboards an employee, the HRMS calls the create operation. The mailbox priya.n@acme.in exists before her first day, and IT does nothing by hand.
Operations
| Operation | What it does |
|---|---|
| Create | Creates a mailbox. |
| Update | Changes the user's details. |
| Delete | Removes the mailbox. |
| List | Lists the users of the domain. |
Good to know
- The API address is https://mail.xgenplus.com, unless a white-labelled address has been set up for your organisation. Your administrator will tell you if so.
- Your administrator issues the key and tells you which IP address rules apply to your server.
- Keep the key secret, and ask for a new one if it is ever shared by mistake.
- For bulk one-off imports, the admin console's bulk add is simpler.
Was this page helpful?
Updated 2026-10-28