Cancel changing your email address
The users.email_change.cancel operation: POST /api/v1/users/me/email_change/cancel in the REST API and the users_email_change_cancel tool in the MCP server.
/api/v1/users/me/email_change/cancelCancels the address change users.email_change.start began: its code stops working and your address stays as
it is. Answers canceled: false when no change was waiting.
Who can call it: the signed-in user, for their own account, in the console.
At a glance
- REST:
POST /api/v1/users/me/email_change/cancel - MCP tool:
users_email_change_cancel - Operation ID:
users.email_change.cancel - Scope: Platform
- Permission:
account:write - Risk tier:
write - Dry run: Supported (send
Ownrecord-Dry-Run: true) - Idempotency:
Idempotency-Keyrequired - Modes: Test and live
- Authentication: API key with the
account:writescope - Since: M13
Request
Body
This operation takes no body.
Response
200 OK with a JSON object:
| Field | Type | Description |
|---|---|---|
object | "email_change_cancellation" | |
canceled | boolean | Whether an address change was waiting (false: there was nothing to cancel). |
Examples
Cancel the change
POST /api/v1/users/me/email_change/cancel
Authorization: Bearer or_test_…
Idempotency-Key: 3f1c9a52-7d0e-4b8f-9a61-0c2d5e8b7f14
Response (200):
{
"object": "email_change_cancellation",
"canceled": true
}
Errors
| Code | HTTP status | When | What to do |
|---|---|---|---|
permission_denied | 403 | The caller isn't a person signed in to the console. | Ask an organization owner or admin for a role or scope that allows this action. |
It can also return these common errors: validation_failed, api_version_unsupported, invalid_json, unsupported_media_type, authentication_required, api_key_invalid, resource_not_found, idempotency_key_required, idempotency_key_reused, idempotency_in_progress, rate_limited, internal_error.