Mutation

deleteCollection

Delete a Collection (strips the tag from items; does not delete items).

MCP: deleteCollection

Arguments

id ID! required: UUID of the Collection to delete (as returned by collections). Collection management is available only in workspaces whose Collections use the standard storage; where they use an older format the ids collections returns are not accepted here and the call returns a userError without changing anything.

Returns

Object, input and enum types open in place — use + to reveal their fields. A type that is already open above the row stops at a ↻ circular marker, and anything nested past the depth limit links out to its own page instead.

deletedCollectionId ID: The id of the deleted Collection. Null when the Collection did not exist.
userErrors [UserError!]!: List of user-facing errors. Populated only when deletion failed.
field [String!]: Path to the input field that caused the error.
message String!: The error message.

Open in explorer ↗

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

Delete a Collection; strips the tag from items without deleting them.

query.graphql

mutation DeleteCollectionDefault($id: ID!) {
  deleteCollection(id: $id) {
    deletedCollectionId
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "id": "e51b749b-1344-535f-a4c5-f878b69d143b"
}

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 DeleteCollectionDefault($id: ID!) {\n  deleteCollection(id: $id) {\n    deletedCollectionId\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "id": "e51b749b-1344-535f-a4c5-f878b69d143b"
  }
}'

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 DeleteCollectionDefault($id: ID!) {
  deleteCollection(id: $id) {
    deletedCollectionId
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "id": "e51b749b-1344-535f-a4c5-f878b69d143b"
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation DeleteCollectionDefault($id: ID!) {
    deleteCollection(id: $id) {
      deletedCollectionId
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "id" => "e51b749b-1344-535f-a4c5-f878b69d143b" } }.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 DeleteCollectionDefault($id: ID!) {
  deleteCollection(id: $id) {
    deletedCollectionId
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"id": "e51b749b-1344-535f-a4c5-f878b69d143b"}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK 8 lines

{
  "data": {
    "deleteCollection": {
      "deletedCollectionId": "e51b749b-1344-535f-a4c5-f878b69d143b",
      "userErrors": []
    }
  }
}