# space.ziran.invite

> Published by [lexicons.pds.ziran.space](https://lexicon.garden/identity/did:plc:axdexdy7p7yvuunn2mvuvy32)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:axdexdy7p7yvuunn2mvuvy32/space.ziran.invite)
- [Documentation](https://lexicon.garden/lexicon/did:plc:axdexdy7p7yvuunn2mvuvy32/space.ziran.invite/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:axdexdy7p7yvuunn2mvuvy32/space.ziran.invite/examples)

## Definitions

### `space.ziran.invite`

**Type**: `record`

An invitation to a Ziran workspace, written by the inviter into their own repo inside the invitee's public-policy inbox space. The inviter must already have added the invitee as a member of the workspace; this record only makes that membership discoverable. Dismissal is app-local: the record belongs to the inviter.

**Key**: `tid`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `doc` | `string` (tid) | No | Optional rkey of a specific space.ziran.doc record to highlight. |
| `name` | `string` | Yes | Human-readable workspace name, so the invite renders without a credential mint. |
| `space` | `string` (at-uri) | Yes | The workspace space the invitee has been added to. |
| `message` | `string` | No | Optional message from the inviter. |
| `createdAt` | `string` (datetime) | Yes |  |

## Raw Schema

```json
{
  "id": "space.ziran.invite",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "space",
          "name",
          "createdAt"
        ],
        "properties": {
          "doc": {
            "type": "string",
            "format": "tid",
            "description": "Optional rkey of a specific space.ziran.doc record to highlight."
          },
          "name": {
            "type": "string",
            "maxLength": 2000,
            "description": "Human-readable workspace name, so the invite renders without a credential mint.",
            "maxGraphemes": 200
          },
          "space": {
            "type": "string",
            "format": "at-uri",
            "description": "The workspace space the invitee has been added to."
          },
          "message": {
            "type": "string",
            "maxLength": 10000,
            "description": "Optional message from the inviter.",
            "maxGraphemes": 1000
          },
          "createdAt": {
            "type": "string",
            "format": "datetime"
          }
        }
      },
      "description": "An invitation to a Ziran workspace, written by the inviter into their own repo inside the invitee's public-policy inbox space. The inviter must already have added the invitee as a member of the workspace; this record only makes that membership discoverable. Dismissal is app-local: the record belongs to the inviter."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```