distribution.techdistribution.tech

MCP tool

Archive a campaign

archive_campaign

Take one campaign out of the list, the same as Archive in the workspace.

Overview

Take one campaign out of the list, the same as Archive in the workspace. Refused while a payment is in progress or any of its work is paid or booked (conflict, has_committed_work). Archiving an archived campaign returns when it was archived. An archived campaign still reads in campaign_status with archived_at set and stage Archived; renaming it or setting its guidelines is refused. Needs an idempotency_key.

Server
https://app.distribution.tech/api/mcp
Scope
campaigns:write
Changes data
Yes, pass an idempotency_key

Arguments

Arguments of archive_campaign
NameTypeRequiredDescription
idempotency_keystringYesYour unique id for this request. Retry with the same id and the same arguments to get the same answer; it never runs twice.
campaign_idstring (uuid)YesThe campaign id from campaign_status or create_campaign.

Call with curl

The server speaks streamable HTTP, so one JSON-RPC tools/call request runs the tool. Set DISTRIBUTION_API_KEY to a key from Developers with the campaigns:write scope; the arguments shown are the required ones.

curl
curl -X POST "https://app.distribution.tech/api/mcp" \
  -H "Authorization: Bearer $DISTRIBUTION_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json, text/event-stream" \
  -d '{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "archive_campaign",
    "arguments": {
      "idempotency_key": "<string>",
      "campaign_id": "<uuid>"
    }
  }
}'

Result

The answer's structuredContent follows the tool's output schema (the same JSON is in its text content). It has these fields:

Result fields of archive_campaign
NameTypeRequiredDescription
campaign_idstring (uuid)Yes
archived_atstring (date-time)Yes
structuredContent, every field with its type
{
  "campaign_id": "<uuid>",
  "archived_at": "<date-time>"
}

Get access

Keys are created in Developers once your brand is approved. Connect an agent to ask for access, then read the agent guide for the full flow.