Skip to main content
Use this endpoint to immediately pause a running campaign. When a campaign is paused, Leadterra stops scheduling new outbound messages, but any emails already in transit are still delivered. Messages that were queued but not yet sent are held and will resume from the same position when you call the start endpoint again. Pausing is useful when you need to update copy, investigate deliverability issues, or temporarily halt outreach. 
POST /v1/campaigns/:id/pause

​
Authorization

All requests must include a Bearer token in the Authorization header. You can find your API key in the Leadterra dashboard under Settings → API Keys.

​
Path Parameters

​
id
string
required
The unique ID of the campaign you want to pause. You receive this ID when you create a campaign. Example: camp_123.

​
Request Body

This endpoint accepts no request body.

​
Example Request

curl --request POST \
  --url https://app.leadterra.co/v1/campaigns/camp_123/pause \
  --header "Authorization: Bearer sk_live_YOUR_KEY" \
  --header "Content-Type: application/json"

​
Response Fields

​
id
string
The campaign ID that was paused.
​
status
string
Updated campaign status. Returns paused on success.
​
pausedAt
string
ISO 8601 timestamp of when the campaign transitioned to paused.

​
Example Response

{
  "id": "camp_123",
  "status": "paused",
  "pausedAt": "2025-01-15T14:22:00Z"
}

​
Notes

  • Calling this endpoint on a campaign that is already paused or in draft status is a no-op — the response returns the current state without error.
  • Emails that were already in transit before the pause signal was received will still be delivered to recipients.
  • To resume sending, call the Start Campaign endpoint with the same campaign ID.

​
Error Codes

HTTP StatusCodeMeaning
400 Bad Requestinvalid_requestThe request was malformed or contained unexpected parameters.
401 Unauthorizedauthentication_failedThe Authorization header is missing, malformed, or the key is invalid.
404 Not Foundcampaign_not_foundNo campaign with the given id exists in your workspace.