PlatformDocs
MCP server

update_campaign

Renames a campaign, starts it (status active: emails start going out to its contacts) or pauses it, or changes its sending days (0 Sunday to 6 Saturday), hours (timeSlot start and end, 0-24), timezone or open/click tracking.

View as Markdown

Update a campaign · Changes data · Acts outside your account

Renames a campaign, starts it (status active: emails start going out to its contacts) or pauses it, or changes its sending days (0 Sunday to 6 Saturday), hours (timeSlot start and end, 0-24), timezone or open/click tracking. Fields left out stay as they are. Confirm with the user before setting status active. Returns 404 when the campaign is not one of this website's.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
websiteIdstringYesanyWebsite ID from list_websites (the campaign's website).
campaignIdstringYesanycampaignId from list_campaigns.
namestringNoanyNew name.
statusstringNoactive, pausedactive to start sending, paused to stop.
daysRangenumber[]No0–6Days to send on, 0 (Sunday) to 6 (Saturday).
timeSlotobjectNoanySending hours in the campaign timezone.
timeSlot.startnumberNo0–23First hour, 0-23.
timeSlot.endnumberNo1–24Last hour, 1-24.
timezonestringNoanyIANA timezone, e.g. Europe/London.
isTrackingEnabledbooleanNoanyTrack opens and clicks.

Tool definition

What your assistant receives from tools/list:

{
  "name": "update_campaign",
  "title": "Update a campaign",
  "annotations": {
    "title": "Update a campaign",
    "readOnlyHint": false,
    "destructiveHint": false,
    "idempotentHint": true,
    "openWorldHint": true
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "websiteId": {
        "type": "string",
        "description": "Website ID from list_websites (the campaign's website)."
      },
      "campaignId": {
        "type": "string",
        "description": "campaignId from list_campaigns."
      },
      "name": {
        "type": "string",
        "description": "New name."
      },
      "status": {
        "type": "string",
        "enum": [
          "active",
          "paused"
        ],
        "description": "active to start sending, paused to stop."
      },
      "daysRange": {
        "type": "array",
        "items": {
          "type": "number",
          "minimum": 0,
          "maximum": 6
        },
        "description": "Days to send on, 0 (Sunday) to 6 (Saturday)."
      },
      "timeSlot": {
        "type": "object",
        "properties": {
          "start": {
            "type": "number",
            "minimum": 0,
            "maximum": 23,
            "description": "First hour, 0-23."
          },
          "end": {
            "type": "number",
            "minimum": 1,
            "maximum": 24,
            "description": "Last hour, 1-24."
          }
        },
        "description": "Sending hours in the campaign timezone."
      },
      "timezone": {
        "type": "string",
        "description": "IANA timezone, e.g. Europe/London."
      },
      "isTrackingEnabled": {
        "type": "boolean",
        "description": "Track opens and clicks."
      }
    },
    "required": [
      "websiteId",
      "campaignId"
    ]
  }
}

On this page