# pub.chive.collaboration.invite

> Published by [chive.pub](https://lexicon.garden/identity/did:plc:7natp5xae72bddaqlkef2t4e)

✓ This is the authoritative definition for this NSID.

## Description

Invitation record from a subject-record author to a potential collaborator. Lives in the inviter's PDS. Generic over any Chive record (collections in v1; eprints, reviews, and other records in the future).

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.invite)
- [Documentation](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.invite/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:7natp5xae72bddaqlkef2t4e/pub.chive.collaboration.invite/examples)

## Definitions

### `pub.chive.collaboration.invite`

**Type**: `record`

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `role` | `string` | No | Role granted by this invitation. Defaults to 'collaborator'. |
| `invitee` | `string` (did) | Yes | DID of the user being invited. |
| `message` | `string` | No | Optional personal note shown to the invitee. |
| `subject` | `ref` → `com.atproto.repo.strongRef` | Yes | StrongRef to any Chive-authored record being shared (collection, eprint, review, etc.). |
| `createdAt` | `string` (datetime) | Yes |  |
| `expiresAt` | `string` (datetime) | No | Optional expiration after which the invite is no longer valid. |

## Raw Schema

```json
{
  "id": "pub.chive.collaboration.invite",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "subject",
          "invitee",
          "createdAt"
        ],
        "properties": {
          "role": {
            "type": "string",
            "description": "Role granted by this invitation. Defaults to 'collaborator'.",
            "knownValues": [
              "collaborator",
              "editor",
              "viewer",
              "co-author",
              "reviewer"
            ]
          },
          "invitee": {
            "type": "string",
            "format": "did",
            "description": "DID of the user being invited."
          },
          "message": {
            "type": "string",
            "maxLength": 500,
            "description": "Optional personal note shown to the invitee.",
            "maxGraphemes": 200
          },
          "subject": {
            "ref": "com.atproto.repo.strongRef",
            "type": "ref",
            "description": "StrongRef to any Chive-authored record being shared (collection, eprint, review, etc.)."
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          },
          "expiresAt": {
            "type": "string",
            "format": "datetime",
            "description": "Optional expiration after which the invite is no longer valid."
          }
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1,
  "revision": 1,
  "description": "Invitation record from a subject-record author to a potential collaborator. Lives in the inviter's PDS. Generic over any Chive record (collections in v1; eprints, reviews, and other records in the future)."
}
```
