removeItemFromCollections

Remove an item from one or more collections.

MCP: removeItemFromCollections

Arguments

collectionIds [ID!] default: []: IDs of collections to remove the item from, as returned by the collections query for this workspace. Several id forms are accepted depending on how the workspace stores Collections. An id from another workspace, or one this workspace cannot write through this API, rejects the WHOLE call with a userErrors entry naming the offending id under collectionIds.
collectionNames [String!] default: []: Names of collections to remove the item from.
itemId ID! required: ID of the item to remove from collections.

Returns

item Item: The updated item.
userErrors [UserError!]!: List of errors that occurred.

Open in explorer ↗

Values are sampled from a demo workspace — substitute your own token and workspace id.

Remove an item from one or more collections.

query.graphql

mutation RemoveItemFromCollectionsDefault($itemId: ID!, $collectionIds: [ID!]) {
  removeItemFromCollections(itemId: $itemId, collectionIds: $collectionIds) {
    item {
      id
      customAttributes
    }
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "itemId": "63c311c4-32f0-5d8c-ac02-78b160f2290a",
  "collectionIds": [
    "122321ce-843e-5b07-9f56-94323c0ae39e"
  ]
}

Headers

Authorization: Bearer docs_demo_token_0000000000000000000000
WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a

Request · cURL

curl https://app.archive.com/api/v2 \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer docs_demo_token_0000000000000000000000' \
  -H 'WORKSPACE-ID: 6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a' \
  -d '{
  "query": "mutation RemoveItemFromCollectionsDefault($itemId: ID!, $collectionIds: [ID!]) {\n  removeItemFromCollections(itemId: $itemId, collectionIds: $collectionIds) {\n    item {\n      id\n      customAttributes\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "itemId": "63c311c4-32f0-5d8c-ac02-78b160f2290a",
    "collectionIds": [
      "122321ce-843e-5b07-9f56-94323c0ae39e"
    ]
  }
}'

Request · Node.js

const response = await fetch("https://app.archive.com/api/v2", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer docs_demo_token_0000000000000000000000",
    "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
  },
  body: JSON.stringify({
    query: `mutation RemoveItemFromCollectionsDefault($itemId: ID!, $collectionIds: [ID!]) {
  removeItemFromCollections(itemId: $itemId, collectionIds: $collectionIds) {
    item {
      id
      customAttributes
    }
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "itemId": "63c311c4-32f0-5d8c-ac02-78b160f2290a",
      "collectionIds": [
        "122321ce-843e-5b07-9f56-94323c0ae39e"
      ]
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation RemoveItemFromCollectionsDefault($itemId: ID!, $collectionIds: [ID!]) {
    removeItemFromCollections(itemId: $itemId, collectionIds: $collectionIds) {
      item {
        id
        customAttributes
      }
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "itemId" => "63c311c4-32f0-5d8c-ac02-78b160f2290a", "collectionIds" => ["122321ce-843e-5b07-9f56-94323c0ae39e"] } }.to_json,
  "Content-Type" => "application/json",
  "Authorization" => "Bearer docs_demo_token_0000000000000000000000",
  "WORKSPACE-ID" => "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a"
)
puts response.body

Request · Python

import json
import requests

query = """
mutation RemoveItemFromCollectionsDefault($itemId: ID!, $collectionIds: [ID!]) {
  removeItemFromCollections(itemId: $itemId, collectionIds: $collectionIds) {
    item {
      id
      customAttributes
    }
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"itemId": "63c311c4-32f0-5d8c-ac02-78b160f2290a", "collectionIds": ["122321ce-843e-5b07-9f56-94323c0ae39e"]}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK

{
  "data": {
    "removeItemFromCollections": {
      "item": {
        "id": "63c311c4-32f0-5d8c-ac02-78b160f2290a",
        "customAttributes": {
          "sentiment": "positive",
          "collections": []
        }
      },
      "userErrors": []
    }
  }
}