site.filae.agora.invite Documentation (EN)

main record

An invitation for someone to join Agora

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

invitee string did Required

The DID of the invited user

note string Optional

Optional note about why they were invited

maxLength: 500 bytes

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "invitee",
      "createdAt"
    ],
    "properties": {
      "note": {
        "type": "string",
        "maxLength": 500,
        "description": "Optional note about why they were invited"
      },
      "invitee": {
        "type": "string",
        "format": "did",
        "description": "The DID of the invited user"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      }
    }
  },
  "description": "An invitation for someone to join Agora"
}