v1

latestOpenAPI 3.0.02026-08-0645062.8 KB

Create a new lead

Create a new lead with the provided details. Requires a valid Bearer token.

post/leads

Request body

firstNamestring required

The first name of the lead

lastNamestring

The last name of the lead

emailstring email

Email address of the lead

phonestring

Phone number of the lead

companystring

Company name of the lead

titlestring

Job title of the lead

locationstring

Location of the lead

descriptionstring

Additional details about the lead

sourcestring

Source of the lead

groupIdstring

stageIdstring

priorityIdstring

labelIdsstring[]

Example request

{
  "firstName": "John",
  "lastName": "Doe",
  "email": "johndoe@example.com",
  "phone": "123-456-7890",
  "company": "Tech Corp",
  "title": "Software Engineer",
  "location": "San Francisco",
  "description": "Interested in our product",
  "source": "Web"
}

Response

Lead created successfully

messagestring

leadIdstring uuid

Example response

{
  "message": "Lead created successfully!",
  "leadId": "c056d1e3-62e8-4ec3-b733-7a7485fa48c8"
}

All 45 operations