blue.registry.invite

registry.blue

Documentation

Invites a user to add items to a list.

main record

Invites a user to add items to a list.

Record Key tid Timestamp-based ID

Properties

collaborator string did Required

DID of the invited collaborator.

createdAt string datetime Required

Timestamp when the invite was created.

expiresAt string datetime Required

Timestamp when the invite expires. Defaults to 72 hours after creation.

list string at-uri Required

AT-URI of the list being shared.

resentAt string datetime Optional

Timestamp when the invite was last resent. Absent if never resent.

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "list",
      "collaborator",
      "createdAt",
      "expiresAt"
    ],
    "properties": {
      "list": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the list being shared."
      },
      "resentAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when the invite was last resent. Absent if never resent."
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when the invite was created."
      },
      "expiresAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when the invite expires. Defaults to 72 hours after creation."
      },
      "collaborator": {
        "type": "string",
        "format": "did",
        "description": "DID of the invited collaborator."
      }
    }
  },
  "description": "Invites a user to add items to a list."
}

Lexicon Garden

@