at.happyproto.actor.confirmContactEmail

Prove the address a contact-email link was sent to, as the account it was sent for. A change waiting for the link becomes the contact email. Opening the same link again answers the same. Customers and staff; anyone else is refused.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · procedure
Kindprocedure
Authorityactor.happyproto.at
Commit rev3n2hhbr6orv22
Indexed

Procedure

procedure · POST

Input

application/json

idempotencyKey

requiredstring

A UUID the client generates once per action and resends on every retry of it.

token

requiredstring

The token from the link's #t= fragment.

  • maxLength: 128

Output

application/json

confirmed

requiredboolean

Always true on success.

Errors

AuthRequired

This endpoint requires an authenticated caller.

Forbidden

The caller is neither a customer nor staff, or the provisioner refused them.

InvalidRequest

The input is malformed, or the provisioner refused it as malformed.

InvalidLink

The token is unknown, belongs to another account, or a newer link replaced it.

ExpiredLink

The link is more than 24 hours old.

EmailNotConfigured

Owner email is not switched on yet.

InvalidEmail

Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.

TooManyLinks

Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.

EmailFailed

Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.

NotFound

Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.

InvalidSlug

Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.

SlugTaken

Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.

NotEntitled

Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.

InstanceLimit

Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.

NoCapacity

Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.

OperationInProgress

Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.

Upstream

The preferences space or the provisioner could not be reached, or answered with an error it does not explain to callers.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • Set the caller's contact email in their preferences space, and send a link to it that proves it. Until the link is opened, the address they had stays in use. Setting the proven address they already have drops a change that is waiting. Customers and staff; anyone else is refused.

  • The caller's contact email and notice settings, from their preferences space on HappyProto (at.happyproto.preferences/self). Only the caller's own. verified and pendingVerified say whether each address is proven to be theirs, which only an opened link does: an address seeded from the PDS at sign-in starts unproven. Customers and staff; anyone else is refused.

  • Remove the caller's contact email. Their preferences space keeps a contact record with no address, so sign-in does not write one back, and every proof and open link is forgotten. The address on their PDS account is untouched. Customers and staff; anyone else is refused.

  • Confirm an email using a token from com.atproto.server.requestEmailConfirmation.

  • Record the email address on the caller's PDS account with HappyProto, read server-side from their PDS session. The dashboard calls it once after each sign-in. The PDS reports the address only when the sign-in granted it (transition:email or account:email); without one, the last recorded address is kept, and an unconfirmed address never replaces a confirmed one. The address itself is never returned. Customers and staff; anyone else gets recorded = false.