at.happyproto.actor.getContact
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.
Details · query
| Kind | query |
|---|---|
| Authority | actor.happyproto.at |
| Commit rev | 3n2hhbr7rbl22 |
| Indexed |
Query
query · GETOutput
application/jsonThe contact email in use. Absent when there is none: never set, or removed.
Whether owner contact email is switched on. While it is off, nothing can be set and nothing is mailed.
Whether the caller gets maintenance emails. True until they turn it off.
pendingEmail
stringAn address waiting for its link to be opened. Until then email stays in use.
pendingVerified
booleanWhether pendingEmail's link has been opened; present with pendingEmail. It becomes email at the next change or sign-in.
Whether email is proven to be the caller's. HappyProto mails only a proven address.
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.
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.
InvalidLink
Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.
ExpiredLink
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 matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
at.happyproto.actor.setContactEmail
procedureSet 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.
-
at.happyproto.actor.confirmContactEmail
procedureProve 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.
-
at.happyproto.actor.removeContactEmail
procedureRemove 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.
-
An account's contact email for HappyProto, at rkey self in the account's at.happyproto.preferences/self space, written only as its owner. Kept in that space, never in a public repo: HappyProto drops any such record published to one. HappyProto mails only an address proven through a link it sent.
-
at.happyproto.actor.setNotices
procedureTurn the caller's maintenance emails on or off, in their preferences space. Account email (links they ask for, a note when their contact email changes, changes to the terms) has no switch. Customers and staff; anyone else is refused.