API reference

Leads

• GETList and find leads/leads

  The workspace’s leads, newest first, a page at a time.

• PATCHChange many leads/leads

  Up to 1,000 leads’ changes in one call: names, the short company name, company, job title, email, custom fields and tags, as PATCH /leads/{leadId} makes them.

• GETGet a lead/leads/{leadId}

  A lead with tags, custom fields, lists and where they are in each campaign.

• PATCHChange a lead/leads/{leadId}

  Changes how a person is named and what Salesteam knows about them, with the same rules as the app: first and last name ({{first_name}}), the short company name ({{company_short}}), company, job title, email, custom fields, and tags to add or take off.

• DELDelete a lead/leads/{leadId}

  Deletes a lead, as the app’s Delete does: they leave every list and any campaign that hasn’t reached them.

• GETList custom fields/custom-fields

  The workspace's custom fields, in the order Salesteam shows them.

• POSTAdd leads to a list/lists/{listId}/leads

  Adds up to 1,000 people to a list, with the same body and results as adding to a campaign: leads to import by LinkedIn link, or people already saved by leadId or email.

• POSTAdd leads to a campaign/campaigns/{campaignId}/leads

  Adds up to 1,000 people to a campaign’s list: leads to import by LinkedIn link (with their details), or people already saved by leadId or email.

• POSTStop a lead in a campaign/campaigns/{campaignId}/leads/stop

  Takes a person out of a campaign for good, for example once they booked a call elsewhere.

• POSTPause a lead in a campaign/campaigns/{campaignId}/leads/pause

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

• POSTResume a paused lead/campaigns/{campaignId}/leads/resume

  Resumes a person on hold, at the step where they paused.