Status Support Sign up

Leads

Create a lead

POST

/api/v1/leads

Request bodyrequired

identitiesrequired

object

linkedinoptional	string
instagramoptional	string

timezonerequired

string

firstNameoptional

string

lastNameoptional

string

companyNameoptional

string

companyDomainoptional

string

jobTitleoptional

string

emailoptional

string

imageUrloptional

string

propertiesoptional

object

Response

201Created lead.

lead

object

id

string · uuid

firstName

string | null

lastName

string | null

companyName

string | null

companyDomain

string | null

jobTitle

string | null

email

string | null

imageUrl

string | null

timezone

string

identities

object[]

liveEnrollment

object | null

campaignId	string · uuid
campaignName	string
status	"active" \| "waiting" \| "completed" \| "stopped" \| "failed"

createdAt

string · date-time

updatedAt

string · date-time

properties

object

enrollments

object[]

Errors

400: Bad request
401: Unauthorized: missing or invalid API key
403: Forbidden
404: Not found
422: Invalid request payload

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