Skip to content

Docs

Get API key

Leads

Pause a lead in a campaign

POST/campaigns/{campaignId}/leads/pause

Nothing is sent to the person until they are resumed, and no other campaign takes them meanwhile.

Try itSend a real request with your API key

API key campaignId path Body JSON

This changes your workspace, as the same change in the app would. Your key stays in this page and goes only to Salesteam.

Path

campaignIdstringRequired
The campaign.

Headers

Idempotency-Keystring
Any unique value up to 255 characters, like a UUID. The request runs once; repeats within 24 hours get the first answer, with Idempotent-Replayed: true. Up to 255 characters.

Body

leadIdstring or null
Up to 180 characters.
linkedinUrlstring or null
Up to 1,000 characters.
emailstring · email or null
The lead’s email: the one Salesteam found or was sent. Handy when a calendar or CRM knows only the email. Up to 254 characters.

Answer

200 OK What changed.

dataLeadControlResultRequired
Inside it
- leadobjectRequired
  Inside it
  - idstringRequired
  - fullNamestringRequired
  - linkedinUrlstringRequired
- campaignobjectRequired
  Inside it
  - idstringRequired
    The campaign's ID.
  - namestringRequired
    The campaign's name.
- statusstringRequired
  Where the person is in a campaign. One of active, waiting_for_acceptance, retrying, paused, needs_review, replied, suppressed, finished, stopped.
- changedbooleanRequired
  false when nothing needed to change, so repeating a call is safe.

Errors

400 Bad requestinvalid_request invalid_json duplicate_in_request
401 Unauthorizedunauthorized
404 Not foundnot_found not_in_campaign
409 Conflictconflict idempotency_in_progress workspace_busy campaign_finished campaign_without_list tag_limit lead_has_history campaign_not_launched campaign_cannot_resume ambiguous_email
422 Can’t processidempotency_key_reused
429 Too many requestsrate_limited
500 Server errorserver_error

Every error has the same shape. See Errors.

POST /campaigns/{campaignId}/leads/pause

curl -X POST "https://app.salesteam.dev/api/v1/campaigns/CAMPAIGN_ID/leads/pause" \
  -H "Authorization: Bearer $SALESTEAM_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
  "linkedinUrl": "https://www.linkedin.com/in/jamie-lee-example"
}'

const response = await fetch("https://app.salesteam.dev/api/v1/campaigns/CAMPAIGN_ID/leads/pause", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SALESTEAM_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(),
  },
  body: JSON.stringify({
    "linkedinUrl": "https://www.linkedin.com/in/jamie-lee-example"
  }),
});
console.log(response.status, await response.json());

import os, uuid
import requests

response = requests.post(
    "https://app.salesteam.dev/api/v1/campaigns/CAMPAIGN_ID/leads/pause",
    headers={"Authorization": f"Bearer {os.environ['SALESTEAM_API_KEY']}", "Idempotency-Key": str(uuid.uuid4())},
    json={
        "linkedinUrl": "https://www.linkedin.com/in/jamie-lee-example",
    },
)
print(response.status_code, response.json())

200 answer

{
  "data": {
    "lead": {
      "id": "lead_8f2c",
      "fullName": "Jamie Lee",
      "linkedinUrl": "https://www.linkedin.com/in/jamie-lee-example"
    },
    "campaign": {
      "id": "camp_7d1e",
      "name": "EU founders"
    },
    "status": "paused",
    "changed": true
  }
}