Docs
Get API key

Get started

Changing leads

PATCH /leads/{leadId} changes only the fields you send: first and last name, companyShort (what {{company_short}} says in messages), company, job title, email, custom fields and tags.

cURL
curl -X PATCH https://app.salesteam.dev/api/v1/leads/LEAD_ID \
  -H "Authorization: Bearer $SALESTEAM_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"firstName":"James","companyShort":"Proper Sky"}'
  • {"clear":["companyShort"]} goes back to the automatic short name. A new company does that too, unless you send companyShort with it.
  • PATCH /leads changes up to 1,000 leads in one call. Name each by leadId, linkedinUrl or email. Each row stands alone: one that fails changes nothing, and the others still save.
  • POST /lists/{listId}/leads/remove takes people off a list. A campaign that already has them keeps going: stop them with POST /campaigns/{campaignId}/leads/stop.