games.gamesgamesgamesgames.toggleListItem Documentation (EN)

main procedure

Add or remove a game from a list. Creates a listItem if none exists, deletes it if one does.

Input

Encodingapplication/json

gameUri stringat-uri Required

AT URI of the game record.

listUri stringat-uri Required

AT URI of the list.

Output

Encodingapplication/json

action string Required

Whether the game was added to or removed from the list.

Known values: added, removed

cid string Optional

CID of the created listItem record. Present when action is 'added'.

uri stringat-uri Optional

AT URI of the created listItem record. Present when action is 'added'.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "listUri",
        "gameUri"
      ],
      "properties": {
        "gameUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT URI of the game record."
        },
        "listUri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT URI of the list."
        }
      }
    },
    "encoding": "application/json"
  },
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "action"
      ],
      "properties": {
        "cid": {
          "type": "string",
          "description": "CID of the created listItem record. Present when action is 'added'."
        },
        "uri": {
          "type": "string",
          "format": "at-uri",
          "description": "AT URI of the created listItem record. Present when action is 'added'."
        },
        "action": {
          "type": "string",
          "description": "Whether the game was added to or removed from the list.",
          "knownValues": [
            "added",
            "removed"
          ]
        }
      }
    },
    "encoding": "application/json"
  },
  "description": "Add or remove a game from a list. Creates a listItem if none exists, deletes it if one does."
}