Documentation

Leads

People you can enroll in a campaign.

What a lead is

A lead is a person you can enroll in a campaign. Add them in the dashboard, one at a time through the API, or up to 500 at a time through the bulk endpoint.

Bulk creation matches on identity, so re-sending a list settles onto the leads it created the first time rather than duplicating anyone. A row whose identity already belongs to a lead comes back as matched, with the fields the row carried patched onto that lead.

Contact

You can store a first name, last name, title, company, domain, email, timezone, and extra properties.

Identities

At least one LinkedIn or Instagram identity is required. You can pass any of the forms below.

LinkedIn input (stored as john-doe or the user id):

  • public identifier: john-doe
  • path: /in/john-doe or in/john-doe
  • profile URL: https://www.linkedin.com/in/john-doe
  • user id: ACoAAA…

Instagram input (stored as john-doe):

  • username: john-doe
  • handle: @john-doe
  • profile URL: https://www.instagram.com/john-doe

In campaigns

The lead page shows every campaign they have been enrolled in, and whether they are live in one now. A lead can only be live in one campaign at a time.

Search docs

Search documentation, API reference, and MCP tools

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy