Remove an email address
Removes the specified email address from the user’s account. Once removed, it is no longer available for authentication, verification or communication.
Removing an email may affect flows that depend on it, such as password recovery or notification delivery.
API-KeyX-API-KEY<token>MonoCloud APIs require authentication with an API key. Retrieve your key from the Tenant Settings section of the MonoCloud dashboard and include it in the request header as: X-API-Key: <your_api_key>
The unique identifier of the user.
The unique identifier of the email address.
uuidResponse Body
application/json
The user's email was removed successfully
TypeScript Definitions
Use the response body type in TypeScript.
User: Represents a user account returned by the operation.
Errors
curl -X DELETE "https://your-domain.us.monocloud.com/api/users/WUgDGqaqzqkRmsgd3PFAT/emails/add5c153-1ae5-4ca7-9678-c8d9385753d2" \ -H "X-API-KEY: <token>"{ "user_id": "string", "disabled": true, "claims": { "property1": null, "property2": null }, "public_data": { "property1": null, "property2": null }, "private_data": { "property1": null, "property2": null }, "emails": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "primary": true, "verified": true, "source": null, "verification_source": null, "email": "string" } ], "phone_numbers": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "primary": true, "verified": true, "source": null, "verification_source": null, "phone": "string" } ], "passkeys": [ { "name": null, "passkey_id": "string", "public_key": "string", "aa_guid": "8a066881-0124-4a97-b518-fe03ecf6e108", "backup_state": true, "backup_eligibility": true, "user_present": true, "user_verified": true, "user_agent": "string" } ], "force_password_reset": true, "external_providers": [ { "provider": "string", "authenticator": "google", "provider_user_id": "string", "claims": { "property1": null, "property2": null } } ], "creation_time": 0, "last_updated": 0, "username": null, "has_password": true, "password_updated_at": null, "block_until": null, "failure_count": 0, "sign_in_attempts_count": 0, "last_sign_in_attempt": null, "last_sign_in_attempt_ip": null, "sign_in_success_count": 0, "last_sign_in_success": null, "last_sign_in_success_ip": null, "last_activity": null, "last_known_city": null, "last_known_country": null, "last_known_region": null}Add an email address POST
Adds a new email address to the user profile. Optional parameters allow specifying whether the email should be marked as verified.
Set an email as primary POST
Marks the specified email address as the user's primary email, making it the default for authentication, recovery, and communication.