The team-user endpoints manage records associated with your reseller account. Use them to maintain staff access under your authorised role policy. They do not allow the caller to attach arbitrary WHMCS user IDs or take over another customer account.
IN THIS ARTICLE
01 Manage the user lifecycle
| Method | Resource | Scope | Idempotency-Key |
|---|---|---|---|
GET |
/v2/profile/users |
users:read |
Not required by this route |
POST |
/v2/profile/users |
users:write |
Required |
PATCH |
/v2/profile/users/{userId} |
users:write |
Required |
PUT |
/v2/profile/users/{userId}/roles |
users:write |
Required |
DELETE |
/v2/profile/users/{userId} |
users:write |
Required |
- List the current team and follow the collection's returned pagination metadata.
- Create the intended user with a valid
emailand optionaldisplay_name. The default initial state is invited. - Store the returned user public ID. Apply permitted status or display-name changes through that user's PATCH resource, with a current
If-Matchversion where supported. - Assign roles by PUTing the complete
role_idslist. The supplied roles must be accessible to your tenant. - When a staff member leaves, review their assignments and remove the module team record through the supported DELETE operation if appropriate.
Does invited mean an invitation email was delivered?
No. A stored invited record is not delivery evidence. Verify the actual account invitation or onboarding workflow separately before telling the staff member to expect access. Similarly, mfa_required is a stored policy flag; it is not proof that a user has enrolled or completed a live MFA challenge.
Will a role PUT add one role?
It replaces assignments. Include every role that should remain. An empty list removes the role assignments rather than leaving them unchanged. Compare the user's effective access after a change and retain only the permissions required for their work.
Does deleting the team user delete their WHMCS customer account?
No. The operation affects the module's team record. Account closure, billing ownership and other WHMCS user relationships have separate administrative workflows.
Keep a useful change record with the staff identity, role decision and request reference. Use idempotency for mutations and re-read after version conflicts so an automated staff synchroniser does not overwrite a later access decision.