Mutation

createCollection

Create a Collection (saved tag set) in the current workspace.

MCP: createCollection

Arguments

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.

input CreateCollectionInput! required: Mutation input.
name String! required: Display name for the new Collection. Must be unique within the workspace.

Returns

collection Collection: The newly created Collection. Null on validation failure.
createdAt DateTimeWithZone!: When the Collection was created.
group ViewGroup: Group this Collection belongs to, or null when ungrouped. Populated by moveCollectionToGroup. Always null for workspaces whose Collections use the older storage.
collections [Collection!]! ↻ circular view Collection →: Collections that belong to this group, ordered by their position within the group.
contentViews [ContentView!]!: Content Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob defining which items belong to the view.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveContentViewToGroup.
id ID!: Unique identifier (FilterPreset UUID). Use this with items(presetId:).
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing items via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
createdAt DateTimeWithZone!: When the group was created.
creatorViews [CreatorView!]!: Creator Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob, stored and echoed back but not applied when reading the view: creators(presetId:) narrows only by this view's customAttributeConditions and sort. Use customAttributeConditions to filter which creators the view returns.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveCreatorViewToGroup.
id ID!: Unique identifier of this saved view. Use the returned id with creators(presetId:) to fetch the view's creators.
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing creators via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
id ID!: Unique identifier.
name String!: Display name of the group.
socialProfileViews [SocialProfileView!]!: Social Profile Views that belong to this group, ordered by their position within the group.
createdAt DateTimeWithZone!: When the view was created.
customAttributeConditions JSON!: Custom-attribute conditions narrowing the filter set.
filters JSON!: Opaque filter blob, stored and echoed back but not applied when reading the view: socialProfiles(presetId:) narrows only by this view's customAttributeConditions and sort. Use customAttributeConditions to filter which social profiles the view returns.
group ViewGroup ↻ circular view ViewGroup →: Group this view belongs to, or null when the view is ungrouped. Populated by moveSocialProfileViewToGroup.
id ID!: Unique identifier of this saved view. Use the returned id with socialProfiles(presetId:) to fetch the view's social profiles.
name String!: Display name of the view.
showReportingStats Boolean!: Whether reporting stats are surfaced in the UI for this view.
sort JSON!: Sort directives applied when listing social profiles via this view.
updatedAt DateTimeWithZone!: When the view was last updated.
updatedAt DateTimeWithZone!: When the group was last updated.
id ID!: Unique identifier of the Collection in this workspace. Pass it to addItemToCollections / removeItemFromCollections and to collection(id:).
itemCount Int!: Number of items in this workspace tagged with the Collection.
name String!: Display name of the Collection.
updatedAt DateTimeWithZone!: When the Collection was last updated.
userErrors [UserError!]!: List of user-facing validation errors. Empty on success.
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.

Create a saved Collection (tag set) in the workspace.

query.graphql

mutation CreateCollectionDefault($input: CreateCollectionInput!) {
  createCollection(input: $input) {
    collection {
      id
      name
      itemCount
    }
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "input": {
    "name": "Holiday Favorites"
  }
}

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 CreateCollectionDefault($input: CreateCollectionInput!) {\n  createCollection(input: $input) {\n    collection {\n      id\n      name\n      itemCount\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "input": {
      "name": "Holiday Favorites"
    }
  }
}'

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 CreateCollectionDefault($input: CreateCollectionInput!) {
  createCollection(input: $input) {
    collection {
      id
      name
      itemCount
    }
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "input": {
        "name": "Holiday Favorites"
      }
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation CreateCollectionDefault($input: CreateCollectionInput!) {
    createCollection(input: $input) {
      collection {
        id
        name
        itemCount
      }
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "input" => { "name" => "Holiday Favorites" } } }.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 CreateCollectionDefault($input: CreateCollectionInput!) {
  createCollection(input: $input) {
    collection {
      id
      name
      itemCount
    }
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"input": {"name": "Holiday Favorites"}}},
    headers={
        "Authorization": "Bearer docs_demo_token_0000000000000000000000",
        "WORKSPACE-ID": "6ccefa76-e8ba-5ab0-9c60-e48a9e235a4a",
    },
)
print(json.dumps(response.json(), indent=2))

200 OK 12 lines

{
  "data": {
    "createCollection": {
      "collection": {
        "id": "17ccdf4e-19d2-5b30-9787-d4f0886ddf29",
        "name": "Holiday Favorites",
        "itemCount": 0
      },
      "userErrors": []
    }
  }
}