Mutation

deleteCampaign

Hard-delete a campaign of a type the API provisions, exactly as deleting it in the app does. Irreversible.

MCP: deleteCampaign

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 DeleteCampaignInput! required: Mutation input.
id ID! required: UUID of the campaign to delete. It must be of a type the API provisions (campaignType not null).

Returns

deletedCampaignId ID: The id of the deleted campaign. Null when the campaign was not found.
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 campaign; its roster and posts list go with it, the creators and items survive.

query.graphql

mutation DeleteCampaignDefault($input: DeleteCampaignInput!) {
  deleteCampaign(input: $input) {
    deletedCampaignId
    userErrors {
      field
      message
    }
  }
}

variables.json

{
  "input": {
    "id": "422fac58-557c-5cd4-8986-84ac3db4b133"
  }
}

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 DeleteCampaignDefault($input: DeleteCampaignInput!) {\n  deleteCampaign(input: $input) {\n    deletedCampaignId\n    userErrors {\n      field\n      message\n    }\n  }\n}",
  "variables": {
    "input": {
      "id": "422fac58-557c-5cd4-8986-84ac3db4b133"
    }
  }
}'

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 DeleteCampaignDefault($input: DeleteCampaignInput!) {
  deleteCampaign(input: $input) {
    deletedCampaignId
    userErrors {
      field
      message
    }
  }
}`,
    variables: {
      "input": {
        "id": "422fac58-557c-5cd4-8986-84ac3db4b133"
      }
    }
  })
})
console.log(JSON.stringify(await response.json(), null, 2))

Request · Ruby

require "json"
require "net/http"

query = <<~'GRAPHQL'
  mutation DeleteCampaignDefault($input: DeleteCampaignInput!) {
    deleteCampaign(input: $input) {
      deletedCampaignId
      userErrors {
        field
        message
      }
    }
  }
GRAPHQL

response = Net::HTTP.post(
  URI("https://app.archive.com/api/v2"),
  { query: query, variables: { "input" => { "id" => "422fac58-557c-5cd4-8986-84ac3db4b133" } } }.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 DeleteCampaignDefault($input: DeleteCampaignInput!) {
  deleteCampaign(input: $input) {
    deletedCampaignId
    userErrors {
      field
      message
    }
  }
}
"""

response = requests.post(
    "https://app.archive.com/api/v2",
    json={"query": query, "variables": {"input": {"id": "422fac58-557c-5cd4-8986-84ac3db4b133"}}},
    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": {
    "deleteCampaign": {
      "deletedCampaignId": "422fac58-557c-5cd4-8986-84ac3db4b133",
      "userErrors": []
    }
  }
}