at.happyproto.actor.setNotices

Turn 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.

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

Procedure

procedure · POST

Input

application/json

idempotencyKey

requiredstring

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

maintenance

requiredboolean

Whether to get maintenance emails.

Output

application/json

maintenance

requiredboolean

The setting now saved.

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.

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.

EmailNotConfigured

Owner email is not switched on yet.

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.

  • 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.

  • 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.

  • An account's notice settings for HappyProto, at rkey self in the account's at.happyproto.preferences/self space, written only as its owner. No record: every notice is on. Kept in that space, never in a public repo: HappyProto drops any such record published to one.