TuCloudAPI requestadminuseremail
TuCloudAPI function to manage FuturePBX (the cloud PBX). Available to: SuperRoot, Operator, Client.
pbx parameter (the PBX name, e.g. tucall). The server verifies that your ukey's own account owns that PBX, whatever its role; otherwise, and also for a PBX that does not exist, it returns {"ok":false,"code":"forbidden"}.Description
Ask to change a portal user's EMAIL (their magic-link login), the twin of requestpbxemail. The new address is normalized (trim + lower-case) and checked: refusals with field email and reason required | format | too_long | same (the confirmed address) | taken (another user's or a PBX's email) | rate_limited (3 per user and 20 per PBX per hour). A link valid 24 hours is mailed to it; the change is applied by the SERVER when the link is opened, the old address keeps working until then and is notified after. One open change per user: a new address replaces it (on an invited user, the invitation). The address already pending mails nothing and answers the open state. When magiclogin cannot send, nothing changes (auth_unavailable). Follow it with getadminuseremailchange. Requires a non-readonly ukey.
Call
https://tucloudapi.7kas.com:9087/tucloud?func=requestadminuseremail&ukey=YOUR_KEY&pbx=PBX_NAME
GET, or POST with the parameters form-urlencoded in the body. Requires the ukey parameter. Always HTTP 200; the response is a JSON envelope.
Parameters
| Parameter | Type | Required | Default | Meaning |
|---|---|---|---|---|
pbx |
string | Yes | — | FuturePBX NAME (e.g. tucall). The (ukey, pbx) pair is the tenant boundary; the server verifies the ukey owns this PBX and scopes every admin user to it. |
login |
string | Yes | — | The user's _id (login). A new user's is generated by the server and never shown. |
email |
string | Yes | — | The new email (max 128). |
Example
https://tucloudapi.7kas.com:9087/tucloud?func=requestadminuseremail&ukey=KEY&pbx=tucall&login=u0123456789abcdef&email=ana@example.com
Response
{ok:true, status:"pending", email, expires_in} | {ok:false, code, field:"email", reason, message}.
Errors
Always HTTP 200. On failure the body is {"ok":false,"code":"...","message":"..."}. Common codes: missing_pbx, forbidden, invalid_param, not_found, conflict, in_use, db_error, server_busy; the Response section above lists any specific to this function.
Back to TuCloudAPI