Skip to main content
Use this endpoint to start or resume a campaign. When called on a draft campaign, Leadterra immediately begins queueing the first sequence step for all enrolled leads and transitions the campaign to running status. When called on a paused campaign, sending resumes from where it left off. The campaign must have at least one enrolled lead before you call this endpoint, otherwise the request will return an error.
POST /v1/campaigns/:id/start

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 start. 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/start \
  --header "Authorization: Bearer sk_live_YOUR_KEY" \
  --header "Content-Type: application/json"

Response Fields

id
string
The campaign ID that was started.
status
string
Updated campaign status. Returns running on success.
startedAt
string
ISO 8601 timestamp of when the campaign transitioned to running.

Example Response

{
  "id": "camp_123",
  "status": "running",
  "startedAt": "2025-01-15T11:00:00Z"
}

Notes

  • The campaign must have at least one enrolled lead before calling this endpoint. If no leads are enrolled, the API returns 400 Bad Request with code no_leads_enrolled.
  • Calling this endpoint on a campaign that is already running is a no-op — the response returns the current state without error.
  • Once running, Leadterra respects the send volume limits of the assigned sender pool. Use the Sender Pools endpoint to check remaining capacity.

Error Codes

HTTP StatusCodeMeaning
400 Bad Requestno_leads_enrolledThe campaign has no enrolled leads and cannot be started.
400 Bad Requestno_sequence_stepsThe campaign has no sequence steps defined.
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.