Auth

Send a verification code to a new sign-in email

post/auth/email-change

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/auth/email-change
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Request body

$schemastring uri

A URL to the JSON Schema for this object.

new_emailstring email required

New sign-in email address

reauth_grantstring required

One-time grant for identity.email.change

Example request

{
  "$schema": "https://example.com/api/v1/schemas/BeginEmailChangeInputBody.json"
}

Response

Created

$schemastring uri

A URL to the JSON Schema for this object.

expires_atstring date-time required

Challenge expiration time

idstring required

Email-change challenge ID

new_emailstring required

Address awaiting confirmation

sent_atstring date-time

When the latest code was sent

Example response

{
  "$schema": "https://example.com/api/v1/schemas/EmailChangeSummary.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.