API Reference

Start a sign-in email change

post
https://api.wingspan.app/v3/platform/persons//change-email

Sends a confirmation link to the new email address. Only the Person themself may call this operation with a signed-in session; API keys are not accepted. Requires recent MFA step-up for HighRiskWriteAction. Confirming the change signs the Person out of every V3 session. The new address then becomes both the sign-in and displayed email address.

Requires a session with recent MFA step-up for HighRiskWriteAction. If step-up is missing or expired, this operation returns 403 StepUpMfaRequired; create and verify an MFA challenge at /v3/platform/mfa-challenges with requiredFor: "HighRiskWriteAction", then retry.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Unique identifier of a Person.

Body Params
string
required
length ≥ 1

New email address; trimmed, lowercased, and validated by the service.

Headers
string
length between 1 and 255
^[\x21-\x7e]{1,255}$

Optional idempotency token for authenticated POST and PATCH requests. Reusing the same key and body returns the cached response for 24 hours, except credential operations that explicitly document a 409 because one-time secret material is never cached; reusing it with a different body returns 409 IdempotencyKeyConflict. Use 1-255 printable ASCII characters.

Responses
204

Confirmation email requested

Updated 4 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/problem+json

Updated 4 days ago

Did this page help you?