pause_campaign
Pause an active email campaign to immediately stop all sending while retaining leads and pausing sequences. Use to temporarily halt outreach without removing campaign data.
Instructions
Pause campaign to stop sending.
Effects:
Immediately stops all email sending
Leads remain in the campaign
In-progress sequences are paused
Use activate_campaign to resume sending.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| params | Yes |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |
Implementation Reference
- The main handler function for the 'pause_campaign' tool. It takes PauseCampaignInput, calls the Instantly API to pause the campaign via POST /campaigns/{campaign_id}/pause, and returns the JSON result.
async def pause_campaign(params: PauseCampaignInput) -> str: """ Pause campaign to stop sending. Effects: - Immediately stops all email sending - Leads remain in the campaign - In-progress sequences are paused Use activate_campaign to resume sending. """ client = get_client() result = await client.post(f"/campaigns/{params.campaign_id}/pause") return json.dumps(result, indent=2) - Pydantic input schema for the pause_campaign tool, requiring a single 'campaign_id' field.
class PauseCampaignInput(BaseModel): """ Input for pausing a campaign. Stops sending but leads remain. Use activate_campaign to resume. """ model_config = ConfigDict(str_strip_whitespace=True, extra="ignore") campaign_id: str = Field(..., description="Active campaign UUID") - src/instantly_mcp/server.py:82-82 (registration)MCP tool registration annotation specifying that pause_campaign is non-destructive.
"pause_campaign": {"destructiveHint": False}, - src/instantly_mcp/tools/campaigns.py:517-526 (registration)Registration of pause_campaign in the CAMPAIGN_TOOLS list, which is collected by get_all_tools() for server registration.
CAMPAIGN_TOOLS = [ create_campaign, list_campaigns, get_campaign, update_campaign, activate_campaign, pause_campaign, delete_campaign, search_campaigns_by_contact, ]