PlatformDocs
MCP server

remove_prospect_from_campaign

Delete a prospect from its campaign, like "Remove from campaign" in the app: the prospect and its scheduled emails are deleted, emails already sent stay sent, and its history is gone.

View as Markdown

Remove contact from campaign · Deletes or overwrites data

Delete a prospect from its campaign, like "Remove from campaign" in the app: the prospect and its scheduled emails are deleted, emails already sent stay sent, and its history is gone. Nothing is refunded. To halt the sequence but keep the prospect and its history, use stop_prospect instead. Confirm with the user before calling. prospectId comes from get_prospects or add_prospect_to_campaign; campaignId from list_campaigns. Both must be 24 hex characters. Returns removed: true and the prospectId.

ConnectionAccount URL, team member URL or OAuth

Parameters

ParameterTypeRequiredAcceptsDescription
prospectIdstringYesanyProspect id (24 hex characters) from get_prospects or add_prospect_to_campaign.
campaignIdstringYesanyId of the campaign the prospect belongs to (24 hex characters), from list_campaigns.

Tool definition

What your assistant receives from tools/list:

{
  "name": "remove_prospect_from_campaign",
  "title": "Remove contact from campaign",
  "annotations": {
    "title": "Remove contact from campaign",
    "readOnlyHint": false,
    "destructiveHint": true,
    "idempotentHint": true,
    "openWorldHint": false
  },
  "inputSchema": {
    "type": "object",
    "properties": {
      "prospectId": {
        "type": "string",
        "description": "Prospect id (24 hex characters) from get_prospects or add_prospect_to_campaign."
      },
      "campaignId": {
        "type": "string",
        "description": "Id of the campaign the prospect belongs to (24 hex characters), from list_campaigns."
      }
    },
    "required": [
      "prospectId",
      "campaignId"
    ]
  }
}

On this page