Skip to content

Campaigns

Campaigns group related opportunities together. A default "General" campaign always exists and is used when no campaign is specified for a new opportunity.

Campaign Statuses

  • active
  • paused
  • completed

create_campaign

Create a new campaign to group related opportunities.

Parameters

ParameterTypeRequiredDescription
namestringYesCampaign name
descriptionstringNoDescription
statusstringNoactive, paused, or completed (default: active)
start_datestringNoStart date (YYYY-MM-DD)
end_datestringNoEnd date (YYYY-MM-DD)

Example

json
{
  "name": "create_campaign",
  "arguments": {
    "name": "Product Launch Q2 2026",
    "description": "PR push for the v3 launch",
    "start_date": "2026-04-01",
    "end_date": "2026-06-30"
  }
}

get_campaign

Get a campaign by ID with its opportunities.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesCampaign ID

Example

json
{
  "name": "get_campaign",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

list_campaigns

List campaigns with optional filters.

Parameters

ParameterTypeRequiredDescription
statusstringNoFilter by status: active, paused, completed
include_archivedbooleanNoInclude archived campaigns (default: false)
limitnumberNoMax results (default: 50)
offsetnumberNoOffset for pagination (default: 0)

Example

json
{
  "name": "list_campaigns",
  "arguments": {
    "status": "active"
  }
}

update_campaign

Update campaign fields.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesCampaign ID
namestringNoCampaign name
descriptionstringNoDescription
statusstringNoactive, paused, or completed
start_datestringNoStart date (YYYY-MM-DD)
end_datestringNoEnd date (YYYY-MM-DD)

Example

json
{
  "name": "update_campaign",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "status": "completed"
  }
}

archive_campaign

Soft-delete a campaign.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesCampaign ID

Example

json
{
  "name": "archive_campaign",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

restore_campaign

Restore an archived campaign.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesCampaign ID

Example

json
{
  "name": "restore_campaign",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

campaign_summary

Get an overview of a campaign including opportunity counts by stage and total coverage.

Parameters

ParameterTypeRequiredDescription
idstring (UUID)YesCampaign ID

Example

json
{
  "name": "campaign_summary",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
}

Response Shape

json
{
  "campaign": { "id": "...", "name": "...", "status": "active", "..." : "..." },
  "opportunity_count": 12,
  "stage_breakdown": {
    "researching": 2,
    "pitched": 5,
    "in_progress": 3,
    "published": 2
  },
  "coverage_count": 4
}