# net.atpix.gallery.updateCollectionRule

> Published by [lexicon.atpix.net](https://lexicon.garden/identity/did:plc:x4crpdfko2d7xrcd5eovpwex)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.updateCollectionRule)
- [Documentation](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.updateCollectionRule/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:x4crpdfko2d7xrcd5eovpwex/net.atpix.gallery.updateCollectionRule/examples)

## Definitions

### `net.atpix.gallery.updateCollectionRule`

**Type**: `procedure`

Update an existing collection rule.

#### Input

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `uri` | `string` (at-uri) | Yes |  |
| `name` | `string` | No |  |
| `active` | `boolean` | No |  |
| `hashtags` | `array` | No |  |
| `description` | `string` | No |  |
| `targetScope` | `ref` → `net.atpix.gallery.defs#targetScope` | No |  |
| `followedActors` | `array` | No |  |
| `targetAlbumUri` | `string` (at-uri) | No |  |
| `useFollowGraph` | `boolean` | No |  |
| `includeOwnPhotos` | `boolean` | No |  |

#### Output

**Encoding**: `application/json`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |

## Raw Schema

```json
{
  "id": "net.atpix.gallery.updateCollectionRule",
  "defs": {
    "main": {
      "type": "procedure",
      "input": {
        "schema": {
          "type": "object",
          "required": [
            "uri"
          ],
          "properties": {
            "uri": {
              "type": "string",
              "format": "at-uri"
            },
            "name": {
              "type": "string",
              "maxLength": 200
            },
            "active": {
              "type": "boolean"
            },
            "hashtags": {
              "type": "array",
              "items": {
                "type": "string",
                "maxLength": 64
              }
            },
            "description": {
              "type": "string",
              "maxLength": 2000
            },
            "targetScope": {
              "ref": "net.atpix.gallery.defs#targetScope",
              "type": "ref"
            },
            "followedActors": {
              "type": "array",
              "items": {
                "type": "string",
                "format": "did"
              }
            },
            "targetAlbumUri": {
              "type": "string",
              "format": "at-uri"
            },
            "useFollowGraph": {
              "type": "boolean"
            },
            "includeOwnPhotos": {
              "type": "boolean"
            }
          }
        },
        "encoding": "application/json"
      },
      "output": {
        "schema": {
          "type": "object",
          "required": [
            "uri",
            "cid"
          ],
          "properties": {
            "cid": {
              "type": "string",
              "format": "cid"
            },
            "uri": {
              "type": "string",
              "format": "at-uri"
            }
          }
        },
        "encoding": "application/json"
      },
      "description": "Update an existing collection rule."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```