# cloud.substratum.place.inviteOffer

> Published by [official.fileorbit.cloud](https://lexicon.garden/identity/did:plc:s6kq5tsir7nbyrciloncz5b3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:s6kq5tsir7nbyrciloncz5b3/cloud.substratum.place.inviteOffer)
- [Documentation](https://lexicon.garden/lexicon/did:plc:s6kq5tsir7nbyrciloncz5b3/cloud.substratum.place.inviteOffer/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:s6kq5tsir7nbyrciloncz5b3/cloud.substratum.place.inviteOffer/examples)

## Definitions

### `cloud.substratum.place.inviteOffer`

**Type**: `object`

Durable household invite offer authored by the inviter (ADR 82).

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `status` | `string` | Yes |  |
| `groupId` | `string` | No |  |
| `inviteId` | `string` | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |
| `expiresAt` | `string` (datetime) | Yes |  |
| `inviteeDid` | `string` (did) | Yes |  |
| `inviteeHandle` | `string` | No |  |

## Raw Schema

```json
{
  "id": "cloud.substratum.place.inviteOffer",
  "defs": {
    "main": {
      "type": "object",
      "required": [
        "inviteId",
        "inviteeDid",
        "status",
        "expiresAt",
        "createdAt"
      ],
      "properties": {
        "status": {
          "type": "string",
          "knownValues": [
            "pending",
            "accepted",
            "declined",
            "expired",
            "revoked"
          ]
        },
        "groupId": {
          "type": "string"
        },
        "inviteId": {
          "type": "string"
        },
        "createdAt": {
          "type": "string",
          "format": "datetime"
        },
        "expiresAt": {
          "type": "string",
          "format": "datetime"
        },
        "inviteeDid": {
          "type": "string",
          "format": "did"
        },
        "inviteeHandle": {
          "type": "string"
        }
      },
      "description": "Durable household invite offer authored by the inviter (ADR 82)."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```
