# blue.registry.invite

> Published by [registry.blue](https://lexicon.garden/identity/did:plc:4olik72a346dcc2hppt7ioo4)

✓ This is the authoritative definition for this NSID.

## Description

An invitation for another user to collaborate on a list.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:4olik72a346dcc2hppt7ioo4/blue.registry.invite)
- [Documentation](https://lexicon.garden/lexicon/did:plc:4olik72a346dcc2hppt7ioo4/blue.registry.invite/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:4olik72a346dcc2hppt7ioo4/blue.registry.invite/examples)

## Definitions

### `blue.registry.invite`

**Type**: `record`

Invites a user to add items to a list.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `list` | `string` (at-uri) | Yes | AT-URI of the list being shared. |
| `resentAt` | `string` (datetime) | No | Timestamp when the invite was last resent. Absent if never resent. |
| `createdAt` | `string` (datetime) | Yes | Timestamp when the invite was created. |
| `expiresAt` | `string` (datetime) | Yes | Timestamp when the invite expires. Defaults to 72 hours after creation. |
| `collaborator` | `string` (did) | Yes | DID of the invited collaborator. |

## Raw Schema

```json
{
  "id": "blue.registry.invite",
  "defs": {
    "main": {
      "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."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "description": "An invitation for another user to collaborate on a list."
}
```