# social.grain.unspecced.putPoolFavorite

> Favourite, or unfavourite, a gallery in a group's pool. The record is the viewer's own, written into the pool rather than their public repo: in the public repo it would name a private gallery to the whole network.

- Kind: procedure
- Authority: unspecced.grain.social
- Lexicon: 1
- Published by [grain.social](https://lexicon.garden/identity/did:plc:e7rftrdyz5e2rw4y6ocszew2), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:e7rftrdyz5e2rw4y6ocszew2/social.grain.unspecced.putPoolFavorite)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:e7rftrdyz5e2rw4y6ocszew2/social.grain.unspecced.putPoolFavorite/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:e7rftrdyz5e2rw4y6ocszew2/social.grain.unspecced.putPoolFavorite/analytics)

## Procedure (`social.grain.unspecced.putPoolFavorite`)

Type: procedure · POST

### Input (application/json)

- `gallery` (string · at-uri, required): The gallery being favourited, by the uri it would have in its author's repo.
- `group` (string · did, required)
- `on` (boolean, required)

### Output (application/json)

- `on` (boolean, required)
- `rkey` (string): The favourite record, when there is one.

### Errors

- `NotAuthorized`: The viewer is not a member of this pool.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Favourite, or unfavourite, a gallery in a group's pool. The record is the viewer's own, written into the pool rather than their public repo: in the public repo it would name a private gallery to the whole network.",
      "errors": [
        {
          "description": "The viewer is not a member of this pool.",
          "name": "NotAuthorized"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "gallery": {
              "description": "The gallery being favourited, by the uri it would have in its author's repo.",
              "format": "at-uri",
              "type": "string"
            },
            "group": {
              "format": "did",
              "type": "string"
            },
            "on": {
              "type": "boolean"
            }
          },
          "required": [
            "group",
            "gallery",
            "on"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "on": {
              "type": "boolean"
            },
            "rkey": {
              "description": "The favourite record, when there is one.",
              "type": "string"
            }
          },
          "required": [
            "on"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.grain.unspecced.putPoolFavorite",
  "lexicon": 1
}
```