Sign in
email-verification

Record that the user closed the verify-email prompt

Call when the user dismisses the in-app prompt without verifying. Increments the dismiss counter and returns the updated status. When called with an email that has no user row yet, the row is created (unverified, default commission plan) so counting starts from the very first prompt. When mustVerify is true the app must keep the prompt open until the email is verified. No-op for already verified users.

post/email-verification/dismiss

Request body

userIdnumber

User ID

emailstring

User email, used when userId is not known

namestring

Display name, used only when the email has no user row yet and one is created on this first dismissal. Defaults to the part of the email before @.

Example request

{
  "userId": 123,
  "email": "user@example.com",
  "name": "John Doe"
}

Response

successboolean required
userIdnumber nullable required

null when the email has no user row yet (tracked=false)

emailstring required
verifiedboolean required
verifiedAtstring date-time nullable
dismissCountnumber required

Times the user closed the verify-email prompt without verifying

maxDismissalsnumber required

Dismissals allowed before the prompt becomes non-dismissable

remainingDismissalsnumber required

Dismissals the user still has left (0 once verified)

mustVerifyboolean required

True when the email is unverified and the limit is reached: the app must keep the prompt open

lastDismissedAtstring date-time nullable
trackedboolean required

false when the email has no user row yet; counting starts on the first POST /dismiss

messagestring

Example response

{
  "success": true,
  "userId": 123,
  "email": "user@example.com",
  "dismissCount": 2,
  "maxDismissals": 5,
  "remainingDismissals": 3,
  "tracked": true,
  "message": "Dismissal recorded"
}

Changes

Changed in 2 of the 4 revisions of this API.13

  • 1f6f3b4ce14b12See the full diff
    • ▲

      the response property became nullable for the status

      response-property-became-nullable

    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the required property to the response with the status

      response-required-property-added

  • f7cc9325b5b71See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog