Skip to Content
RankParseDocs
ChangelogDashboardGet API key
DocumentationAPI Reference
Outreach

Pause a campaign

Stop one campaign's queued emails from sending without losing them.

POSThttps://api.rankparse.com/v1/outreach/campaigns/:id/pauseFreeAPI key

Pauses one campaign. Its queued emails stay queued but the sending sweep skips them, so resuming continues exactly where it left off. Other campaigns on the same mailbox keep sending. It takes no body and applies immediately for every caller, agents included: stopping never needs approval.

Path parameters

idstringrequired

The campaign id.

Response

okboolean

Always true.

pausedboolean

Always true.

messagestring

Present when the campaign was already paused. Repeating the call is harmless.

Errors

HTTPCodeWhen
403capability_missingYour role cannot manage outreach.
404campaign_not_foundNot in your workspace, or archived.

Plus the shared errors.

MCP tool: outreach_pause_campaign (accepts campaign_id). To stop every campaign on a mailbox at once, set auto_send_enabled to false with Update sending settings.

Resume a campaign

Let its queued emails send again.

Launch a campaign

Put a campaign's emails up for review (agents) or queue them for sending (direct calls).

Resume a campaign

Let a paused campaign's queued emails send again.