Edit a lead's fields and/or replace its manual tags.
Authorization
bearerAuth An API key created under Settings → API & Webhooks.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Any subset of these fields.
Response Body
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/leads/string" \ -H "Content-Type: application/json" \ -d '{ "jobTitle": "VP Engineering", "tags": [ "warm", "q3" ] }'{ "data": { "id": "string", "firstName": "string", "lastName": "string", "headline": "string", "jobTitle": "string", "company": "string", "email": "string", "emailStatus": "bounced", "emailOptOut": true, "location": "string", "picture": "string", "notes": "string", "profileUrl": "string", "publicIdentifier": "string", "openProfile": true, "tags": [ "string" ], "autoTags": [ "string" ], "listIds": [ "string" ], "campaignIds": [ "string" ], "customVariables": { "property1": "string", "property2": "string" }, "source": "string", "lastActivityAt": "2019-08-24T14:15:22Z", "enrichedAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" }}List leads GET
Previous Page
Add leads to a campaign POST
Adds leads from a `leads` array of `{ profileUrl, ... }` objects (or `{ email, ... }` when the workspace has the email channel, see `LeadInput`), or imports a whole lead list with `listId`. The workspace lead is upserted from the fields you pass and enrolled in one call — you don't need to create leads separately first. Caller-supplied fields win over the best-effort LinkedIn lookup. Leads already in the campaign are skipped. Max 1000 leads per request. Every enrolled lead is also saved to the campaign's own list, created on the first enrollment and named "<campaign name>'s leads" (exposed as `listId` on the campaign). That list and the campaign stay in step: adding leads to it enrolls them, removing leads from it removes them from the campaign. Leads imported with `listId` keep their source list too. The response's `listId` is the campaign's own list for a `leads` array, or the source list for a `listId` import.