Create Lead

recruitment/create-lead@1.0.1
14 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

npm i @superfaceai/one-sdk
const { SuperfaceClient } = require('@superfaceai/one-sdk');

const sdk = new SuperfaceClient();

async function run() {
  // Load the profile
  const profile = await sdk.getProfile('recruitment/create-lead@1.0.1');

  // Use the profile
  const result = await profile
    .getUseCase('CreateLead')
    .perform({
      jobId: 'JOB_ID',
      firstName: 'Demo',
      lastName: 'Testing',
      email: 'demo_testing@fakemail.com'
    }, {
      provider: 'mock'
    });

  // Handle the result
  try {
    const data = result.unwrap();
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

run();

Structure details

Input (object)

jobId
Unique identifier of a job that the lead is a good prospect for.
firstName
First name of a lead.
lastName
Last name of a lead.
email
Email of a lead.
phone
Phone number of a lead.
address
Address of a lead.
education
List of sourced education experiences relevant to lead.
workExperience
List of sourced work experiences relevant to lead.
links
List of sourced links relevant to lead. Can contain links to social profiles, portfolios or other.
cv
Object containing either URL to a CV or data encoded in Base64 format with CV document and name with the file name.
source
Name or list of names, with sources from where this lead comes from.

Example

{
  "jobId": "JOB_ID",
  "firstName": "Demo",
  "lastName": "Testing",
  "email": "demo_testing@fakemail.com"
}

Result (object)

id
Unique identifier of a lead
jobId
Unique identifier of a job that the lead is a good prospect for.
rateLimit
Rate limit details.

Example

{
  "id": "LEAD_ID",
  "jobId": "JOB_ID"
}

Implementation details

Provider
mock
Use case
CreateLead
Author
@superface
Source
Verified