moveCollectionToGroup

Move a Collection into a view group, or out (when groupId is null).

MCP: moveCollectionToGroup

Arguments

collectionId ID! required: UUID of the Collection to move (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.
groupId ID: Target ViewGroup UUID. Pass null to remove the Collection from any group it currently belongs to.

Returns

collection Collection: The moved Collection, with the populated group field. Null when the Collection was not found or the move failed.
userErrors [UserError!]!: List of user-facing errors. Empty on success.

Open in explorer ↗

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

Move a Collection into a view group (or out with a null groupId).

query.graphql

mutation MoveCollectionToGroupDefault($collectionId: ID!, $groupId: ID) {
  moveCollectionToGroup(collectionId: $collectionId, groupId: $groupId) {
    collection {
      id
      name
      group {
        id
        name
      }
    }
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "collectionId": "122321ce-843e-5b07-9f56-94323c0ae39e",
  "groupId": "8e0f0ff1-8024-5af5-9506-49091f53a920"
}

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 MoveCollectionToGroupDefault($collectionId: ID!, $groupId: ID) {\n  moveCollectionToGroup(collectionId: $collectionId, groupId: $groupId) {\n    collection {\n      id\n      name\n      group {\n        id\n        name\n      }\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "collectionId": "122321ce-843e-5b07-9f56-94323c0ae39e",
    "groupId": "8e0f0ff1-8024-5af5-9506-49091f53a920"
  }
}'

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 MoveCollectionToGroupDefault($collectionId: ID!, $groupId: ID) {
  moveCollectionToGroup(collectionId: $collectionId, groupId: $groupId) {
    collection {
      id
      name
      group {
        id
        name
      }
    }
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "collectionId": "122321ce-843e-5b07-9f56-94323c0ae39e",
      "groupId": "8e0f0ff1-8024-5af5-9506-49091f53a920"
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation MoveCollectionToGroupDefault($collectionId: ID!, $groupId: ID) {
    moveCollectionToGroup(collectionId: $collectionId, groupId: $groupId) {
      collection {
        id
        name
        group {
          id
          name
        }
      }
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "collectionId" => "122321ce-843e-5b07-9f56-94323c0ae39e", "groupId" => "8e0f0ff1-8024-5af5-9506-49091f53a920" } }.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 MoveCollectionToGroupDefault($collectionId: ID!, $groupId: ID) {
  moveCollectionToGroup(collectionId: $collectionId, groupId: $groupId) {
    collection {
      id
      name
      group {
        id
        name
      }
    }
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"collectionId": "122321ce-843e-5b07-9f56-94323c0ae39e", "groupId": "8e0f0ff1-8024-5af5-9506-49091f53a920"}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK

{
  "data": {
    "moveCollectionToGroup": {
      "collection": {
        "id": "122321ce-843e-5b07-9f56-94323c0ae39e",
        "name": "Best Sellers",
        "group": {
          "id": "8e0f0ff1-8024-5af5-9506-49091f53a920",
          "name": "Northwind Sidebar"
        }
      },
      "userErrors": []
    }
  }
}