You are viewing a section of Superface that will be deprecated in Q4 2023. Until then, you can continue to use it as you have before but we recommend that you migrate to our latest version soon. For more details visit superface.ai/docs/migrate.
Create Lead
recruitment/create-lead@1.0.114 providers
Create Lead
Creates a sourced prospect candidate either for some specific job or any job within a company.
Input
Job Id
First Name
Last Name
Email
Phone
Address
Education
Work Experience
Links
CV (Resume)
Source
Result
Id
Job Id
Rate limit
1.Choose a provider
2.Use CreateLead with mock in your code
Below instructions are for our Node.js SDK. Use OneService for other languages.
npm i @superfaceai/one-sdk
Structure details
Input (object)
jobId
optional
Unique identifier of a job that the lead is a good prospect for.
string
firstName
required
First name of a lead.
string
lastName
required
Last name of a lead.
string
email
required
Email of a lead.
string
phone
optional
Phone number of a lead.
string
address
optional
Address of a lead.
string
education
optional
List of sourced education experiences relevant to lead.
list
id
optional
Unique identifier of lead's education experience.
string
school
optional
Name of a school.
string
degree
optional
Degree aquired by finishing lead's education.
string
fieldOfStudy
optional
Name of a field studied in lead's education.
string
startedAt
optional
ISO8601 timestamp when the education started.
string
endedAt
optional
ISO8601 timestamp when the education ended.
string
workExperience
optional
List of sourced work experiences relevant to lead.
list
id
optional
Unique identifier of lead's work experience.
string
position
optional
Name of position, lead has occupied.
string
summary
optional
Summary of lead's work experience.
string
company
optional
Name of company.
string
industry
optional
Name of industry, the company worked in.
string
current
optional
Boolean representing whether lead still work there.
boolean
startedAt
optional
ISO8601 timestamp when lead started working.
string
endedAt
optional
ISO8601 timestamp when lead stoped working.
string
links
optional
List of sourced links relevant to lead. Can contain links to social profiles, portfolios or other.
list
name
optional
Descriptive name of a link to some URL.
string
url
optional
Actual URL destination of the link.
string
cv
optional
Object containing either URL to a CV or data encoded in Base64 format with CV document and name with the file name.
source
optional
Name or list of names, with sources from where this lead comes from.
Example
Result (object)
id
required
Unique identifier of a lead
string
jobId
optional
Unique identifier of a job that the lead is a good prospect for.
string
rateLimit
optional
Rate limit details.
object
bucket
optional
Different parts of API may have different rate limits.
Bucket identifies to which part of API the rate limits apply.
string
totalRequests
optional
Total requests available in the time window.
number
remainingRequests
optional
Remaining requests available in the time window.
number
remainingRequestsPercentage
optional
Remaining requests available in the time window in percents.
number
resetTimestamp
optional
Timestamp when the rate limits will reset (in Unix Timestamp format). Available only for providers without rolling rate limit window.
number