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.

Repository @happyproto.at did:plc:mo7vq4jbioxwafy5zkcc3eux namespace authority
Details · query
Kindquery
Authorityactor.happyproto.at
Commit rev3n2hhbr7rbl22
Indexed
cid bafyreigdcfejclqxawqema2d6t3purxr46lbacl5sxyddl3f3eukxlfl5y

Checks

Valid
  • unlimited-string defs.main.output.schema.properties.emailNo maxLength, maxGraphemes or format limits this string.
  • unlimited-string defs.main.output.schema.properties.pendingEmailNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "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.",
      "errors": [
        {
          "description": "This endpoint requires an authenticated caller.",
          "name": "AuthRequired"
        },
        {
          "description": "The caller is neither a customer nor staff, or the provisioner refused them.",
          "name": "Forbidden"
        },
        {
          "description": "The input is malformed, or the provisioner refused it as malformed.",
          "name": "InvalidRequest"
        },
        {
          "description": "Owner email is not switched on yet.",
          "name": "EmailNotConfigured"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "InvalidEmail"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "TooManyLinks"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "InvalidLink"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "ExpiredLink"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every contact-email refusal is mapped the same way.",
          "name": "EmailFailed"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "NotFound"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "InvalidSlug"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "SlugTaken"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "NotEntitled"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "InstanceLimit"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "NoCapacity"
        },
        {
          "description": "Passed through from the provisioner. Not expected here; declared because every provisioner refusal is mapped the same way.",
          "name": "OperationInProgress"
        },
        {
          "description": "The preferences space or the provisioner could not be reached, or answered with an error it does not explain to callers.",
          "name": "Upstream"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "email": {
              "description": "The contact email in use. Absent when there is none: never set, or removed.",
              "type": "string"
            },
            "enabled": {
              "description": "Whether owner contact email is switched on. While it is off, nothing can be set and nothing is mailed.",
              "type": "boolean"
            },
            "maintenance": {
              "description": "Whether the caller gets maintenance emails. True until they turn it off.",
              "type": "boolean"
            },
            "pendingEmail": {
              "description": "An address waiting for its link to be opened. Until then email stays in use.",
              "type": "string"
            },
            "pendingVerified": {
              "description": "Whether pendingEmail's link has been opened; present with pendingEmail. It becomes email at the next change or sign-in.",
              "type": "boolean"
            },
            "verified": {
              "description": "Whether email is proven to be the caller's. HappyProto mails only a proven address.",
              "type": "boolean"
            }
          },
          "required": [
            "enabled",
            "verified",
            "maintenance"
          ],
          "type": "object"
        }
      },
      "type": "query"
    }
  },
  "id": "at.happyproto.actor.getContact",
  "lexicon": 1
}