Klenty Glossary
Here is a collection of terms frequently used in Klenty to help you get started.
Cadence - a sequence of Emails and follow-ups that you create to reach out to Prospects.
Prospect - contacts/leads you will be reaching out to.
Standard Fields - default fields for Prospects in Klenty that you can use
personalize your emails - like, Name, Email, etc.
Custom Fields - Prospect fields created by you for advanced personalization.
List - Prospects belong to a default list, which you can change. Prospects can only belong to one list.
Tags - can be assigned to Prospects to organize and search efficiently.
Authentication
The Klenty API follows the REST paradigm and requires you to have a unique API Key.
Generating Klenty API key
To access the Klenty REST APIs, you need to authenticate your requests using the Klenty API Key.
Login to your Klenty account. Go to Settings → Integrations → Klenty API Key
Click on the key icon to generate an API Key
URL Parameter
All API request URLs start with:
In the above HTTP request, the username is a URL parameter.
Query Parameter
Anything you give after ‘?’ in the URI is called a query parameter.
The above URI has one query parameter: list name.
API Key
All API requests require authentication. You need to provide your key in the HTTP request header via the Key parameter.
API Name: x-API-key
Data Types
We use JSON as the primary data type.
Content Type - JSON(application/json)
PUBLIC APIs
Get prospect detail by Email
This endpoint expects an email address and will return an object containing details of the Prospect who matches that email address.
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?Email=maud@klenty.com
The response includes the following values:
Id (string): the Prospect’s unique id as set by Klenty.
Email (string): the Prospect’s Email id.
FirstName (string): the value set for the Prospect’s First Name.
Company (string): the value set for the Prospect’s Company name.
Phone (string): the value set for the Prospect’s Phone number.
FullName (string): the value set for the Prospect’s Full Name.
LastName (string): the value set for the Prospect’s Last Name.
MiddleName (string): the value set for the Prospect’s Middle Name.
Account (string): the value set for the Prospect’s Account field.
Department (string): the value set for the Prospect’s Department field.
CompanyDomain (string): the value set for the Prospect’s Company Domain field.
Title (string): the value set for the Prospect’s Title field.
TwitterId (string): the value set for the Prospect’s Twitter field.
CompanyPhone (string): the value set for the Prospect’s Company Phone field value.
CompanyEmail (string): the value set for the Prospect’s Company Email field.
LinkedinURL (string): the value set for the Prospect's LinkedIn URL field.
City (string): the value set for the Prospect’s City field.
Country (string): the value set for the Prospect’s Country field.
Location (string): the value set for the Prospect’s location.
List (string): the list the Prospect belongs to.
Tags (string): tags that are added to the Prospect, if any.
assignTo (string): the email address of the user who created the Prospect or is assigned as the owner of the Prospect.
Sample Response:
{
"id": "5ea6ff1820a3000012b795f4",
"FullName": "Rex A Jose",
"FirstName": "Rex",
"LastName": "Jose",
"MiddleName": "A",
"Account": "Payments",
"Department": "Testing",
"Company": "Klenty",
"CompanyDomain": "klenty.com",
"Title": "SE",
"Location": "California",
"Phone": "+12482394986",
"Email": "rex@klenty.com",
"TwitterId": "https://twitter.com/klentyhq",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "+13958059876",
"City": "San Francisco",
"Country": "United States",
"LinkedinURL": "https://www.linkedin.com/company/klenty-com",
"Tags": "paid",
"List": "leads",
"assignTo": "q1@test.com"
}
]
Get prospect status by Email
This endpoint expects the email address of the Prospect, and will return an object containing the status of the Prospect who matches the email address.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/maud@klenty.com/status
The response includes the following values:
cadenceStatus (string): This returns the Cadence status if the Prospect has been added to a Cadence. This can differ from the Prospect status.
prospectStatus (string): This returns the Prospect’s current status
Sample Response:
{
"cadenceStatus": "In Cadence",
"prospectStatus": "In Cadence"
}
Get prospect detail by Prospect creation date:
This endpoint expects the start date & end date and returns the prospects created between those dates. If the end date is not given, the endpoint considers the present date as the end date. The end date should be ahead of the start date.
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?startDate=2020/01/01&endDate=2020/01/03
The response includes the following values:
id (string): the Prospect’s unique id as set by Klenty.
Email (string): the Prospect’s Email id.
FirstName (string): the Prospect’s First Name.
Company (string): the Prospect’s Company name.
Phone (string): the Prospect’s Phone number.
FullName (string): the Prospect’s Full Name.
LastName (string): the Prospect’s Last Name.
MiddleName (string): the Prospect’s Middle Name.
Account (string): the account details the Prospect belongs to.
Department (string): the department the Prospect belongs to.
CompanyDomain (string): the company domain the Prospect belongs to.
Title (string): the Title which the Prospect holds.
TwitterId (string): the Prospect’s Twitter handle.
CompanyPhone (string): the Prospect’s Company Contact Number.
CompanyEmail (string): the Prospect’s Company email id.
LinkedinURL (string): the Prospect’s LinkedIn Public Profile URL.
City (string): the Prospect’s city.
Country (string): the Prospect’s country.
Location (string): the Prospect’s location.
List (string): the list the Prospect belongs to.
Tags (string): tags that are added to the Prospect, if any.
assignTo (string): the email address of the user who created the Prospect or is assigned as the owner of the Prospect.
Sample Response:
[
{
"FullName": "John A Jose",
"FirstName": "John",
"MiddleName": "A",
"LastName": "Jose",
"Company": "klenty",
"CompanyDomain": "klenty.com",
"Account": "Payments",
"Department": "Testing",
"Title": "SE",
"Location": "America",
"Phone": "9600137789",
"Email": "john@klenty.com",
"TwitterId": "Twitter",
"LinkedinURL": "Linkedin@io.co",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "4013778",
"City": "California",
"Country": "US",
"Tags": "paid , new , sales",
"List": "leads",
"assignTo": "q1@test.com"
},
{
"FullName": "Jordan S Mike",
"FirstName": "Jordan",
"MiddleName": "S",
"LastName": "Mike",
"Company": "klenty",
"CompanyDomain": "klenty.com",
"Account": "Payments",
"Department": "Dev",
"Title": "SSE",
"Location": "America",
"Phone": "9622137789",
"Email": "jordan@klenty.com",
"TwitterId": "Twitter",
"LinkedinURL": "Linkedin@io.co",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "40245691",
"City": "Seattle",
"Country": "US",
"Tags": "paid , new , sales",
"List": "leads",
"assignTo": "q1@test.com"
}
]
Get prospect detail by the last updated date:
This endpoint will fetch prospects based on the last date of update (last interaction with the prospect).
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?lastUpdatedDateStart=2020/01/01&lastUpdatedDateEnd=2020/01/03
Note:
lastUpdatedDateStartis a mandatory parameter. This endpoint will not work if this parameter is not provided.If only
lastUpdatedDateStartis provided, the response will contain prospects whose lastUpdatedDate falls under the date range oflastUpdatedDateStart-current date.If both
lastUpdatedDateStartandlastUpdatedDateEndare provided, the response will contain prospects whose lastUpdatedDate falls under the date range of:lastUpdatedDateStart-lastUpdatedDateEnd
The response includes the following values:
id (string): the Prospect’s unique id as set by Klenty.
Email (string): the Prospect’s Email id.
FirstName (string): the Prospect’s First Name.
Company (string): the Prospect’s Company name.
Phone (string): the Prospect’s Phone number.
FullName (string): the Prospect’s Full Name.
LastName (string): the Prospect’s Last Name.
MiddleName (string): the Prospect’s Middle Name.
Account (string): the account details the Prospect belongs to.
Department (string): the department the Prospect belongs to.
CompanyDomain (string): the company domain the Prospect belongs to
Title (string): the Title which the Prospect holds.
TwitterId (string): the Prospect’s Twitter handle.
CompanyPhone (string): the Prospect’s Company Contact Number.
CompanyEmail (string): the Prospect’s Company email id.
LinkedinURL (string): the Prospect’s LinkedIn Public Profile URL.
City (string): the Prospect’s city.
Country (string): the Prospect’s country.
Location (string): the Prospect’s location.
List (string): the list the Prospect belongs to.
Tags (string): tags that are added to the Prospect, if any.
assignTo (string): the email address of the user who created the Prospect, or is assigned as the owner of the Prospect.
Sample Response:
[
{
"FullName": "John A Jose",
"FirstName": "John",
"MiddleName": "A",
"LastName": "Jose",
"Company": "klenty",
"CompanyDomain": "klenty.com",
"Account": "Payments",
"Department": "Testing",
"Title": "SE",
"Location": "America",
"Phone": "9600137789",
"Email": "john@klenty.com",
"TwitterId": "Twitter",
"LinkedinURL": "Linkedin@io.co",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "4013778",
"City": "California",
"Country": "US",
"Tags": "paid , new , sales",
"List": "leads",
"assignTo": "hello@klenty.com"
},
{
"FullName": "Jordan S Mike",
"FirstName": "Jordan",
"MiddleName": "S",
"LastName": "Mike",
"Company": "klenty",
"CompanyDomain": "klenty.com",
"Account": "Payments",
"Department": "Dev",
"Title": "SSE",
"Location": "America",
"Phone": "9622137789",
"Email": "jordan@klenty.com",
"TwitterId": "Twitter",
"LinkedinURL": "Linkedin@io.co",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "40245691",
"City": "Seattle",
"Country": "US",
"Tags": "paid , new , sales",
"List": "leads",
"assignTo": "hello@klenty.com"
}
]
Get Company Cadences
This endpoint expects an email address of a team member and will return an object containing all cadences in that team.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/cadences
The response includes the following values:
id - Cadence id (string): a unique cadence id set by Klenty.
name - Cadence name (string): the name set for the Cadence
Sample response:
[
{
"id": "5e94724513b7350012b5ef3d",
"name": "website visitors"
},
{
"id": "5e946a4b13b7350012b5e3cb",
"name": "outbound campaign"
}
]
Get User cadences
This endpoint expects the email address of the user as an input and will return an object containing cadences that belong to that user.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/cadences?username=helen@klenty.com
The response includes the following values:
id - Cadence id (string): a unique cadence id set by Klenty
name - Cadence name (string): the name set for the Cadence.
Sample Response:
[
{
"id": "5f9472451123450012b5ef3de",
"name": "new leads"
},
{
"id": "5g946a5c23b7350012b5e3cr",
"name": "new signups"
}
]
Get Lists
This endpoint expects an email address of a user and will return an object containing the Prospect Lists created by the team.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/lists
The response will include the following values:
id - List-Id (string): the unique id of the Prospect List.
name - List name (string): The name set for the Prospect List.
Sample Response:
[
{
"id": "5e9d40b565b8860012667f80",
"name": "America"
},
{
"id": "5e9470ed13b7350012b5e69a",
"name": "Leads"
},
{
"id": "5e946d6813b7350012b5e5df",
"name": "New Signups"
},
{
"id": "5e946b1213b7350012b5e3fb",
"name": "India"
}
]
Get Prospect status by ID
This endpoint expects an object ID of a Prospect and will return an object containing the status of that Prospect.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/589c78690d66820b0005ced5/status
The response includes the following values:
cadenceStatus (string): This returns the Cadence status if the Prospect is in a Cadence.
prospectStatus (string): This returns the status of the Prospect.
Sample Response:
{
"cadenceStatus": "In Cadence",
"prospectStatus": "In Cadence"
}Get Prospects by List
This endpoint expects a Prospect List name and will return an object containing all the prospects in the list. You can also provide start & limit values to filter the response. For example, if you have a list with 100 prospects and you give start=2 & limit=10, it fetches your record from 11 to 20. You can fetch up to 1000 records in a request.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?listName=Australia&start=1&limit=10
The response will include the following values:
id - Prospect id (string): the unique Prospect id set by Klenty.
FullName (string): the value set for the Prospect’s Full Name.
FirstName (string): the value set for the Prospect’s First Name.
LastName (string): the value set for the Prospect’s Last Name.
Email (string): the value set for the Prospect’s email id.
listName (string): the list that the Prospect belongs to.
Tags (strings): tags assigned to this Prospect, if any.
assignTo (string): the email address of the user who created or is designated as the owner of the Prospect.
Company (string): the value set for the Prospect’s company field.
List (string): the unique id set for the list that the Prospect belongs to.
Sample Response:
[
{
"id": "5e7e3a809cfee40012744f97",
"FullName": "Roscoe Beckingham",
"FirstName": "Roscoe",
"LastName": "Beckingham",
"Email": "beckinghama@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a809cfee40012744f99",
"FullName": "Demetris Burbank",
"FirstName": "Demetris",
"LastName": "Burbank",
"Email": "demetris@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a809cfee40012744f9b",
"FullName": "Annabal Grastye",
"FirstName": "Annabal",
"LastName": "Grastye",
"Email": "agrastyec@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a809cfee40012744f9d",
"FullName": "Cosimo Cotesford",
"FirstName": "Cosimo",
"LastName": "Cotesford",
"Email": "ccotesfordd@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a809cfee40012744f9f",
"FullName": "Marchelle Gruszka",
"FirstName": "Marchelle",
"LastName": "Gruszka",
"Email": "mgruszkae@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a809cfee40012744fa1",
"FullName": "Shaw Jerzykiewicz",
"FirstName": "Shaw",
"LastName": "Jerzykiewicz",
"Email": "shaw@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a819cfee40012744fa3",
"FullName": "Fayina Burnep",
"FirstName": "Fayina",
"LastName": "Burnep",
"Email": "fayina@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a819cfee40012744fa5",
"FullName": "Theodora Ansley",
"FirstName": "Theodora",
"LastName": "Ansley",
"Email": "tan@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a819cfee40012744fa7",
"FullName": "Drucy McMillan",
"FirstName": "Drucy",
"LastName": "McMillan",
"Email": "dmc@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
},
{
"id": "5e7e3a819cfee40012744fa9",
"FullName": "Claiborne Stockdale",
"FirstName": "Claiborne",
"LastName": "Stockdale",
"Email": "cstock@klenty.com",
"Tags": [
"leads"
],
"List": "5e81cd0b873bee0012e6f631",
"assignTo": "roscoe@klenty.com",
"listName": "Australia"
}
]
Get Prospect details with Custom fields
This endpoint will return the value of custom fields for the specified Prospect along with other fields.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?Email=maud@klenty.com&customFields=true
The response will include the following values:
id (string): the Prospect’s unique id as set by Klenty.
Email (string): the Prospect’s Email id.
FirstName (string): the value set for the Prospect’s First Name field.
Company (string): the value set for the Prospect’s Company field.
Phone (string): the value set for the Prospect’s Phone field.
FullName (string): the value set for the Prospect’s Full Name field.
LastName (string): the value set for the Prospect’s Last Name field.
MiddleName (string): the value set for the Prospect’s Middle Name field.
Account (string): the value set for the Prospect’s Account field.
Department (string): the value set for the Prospect’s Department field.
CompanyDomain (string): the value set for the Prospect’s Company Domain field.
Title (string): the value set for the Prospect’s Title field.
TwitterId (string): the value set for the Prospect’s Twitter field.
CompanyPhone (string): the value set for the Prospect’s Company Phone field.
CompanyEmail (string): the value set for the Prospect’s Company Email field.
LinkedinURL (string): the value set for the Prospect’s LinkedIn URL field.
City (string): the value set for the Prospect’s City field.
Country (string): the value set for the Prospect’s Country field.
Location (string): the value set for the Prospect’s Location field.
List (string): the list the Prospect belongs to.
Tags (string): tags that are added to the Prospect, if any.
CustomFields (string): This returns the values for various custom fields given.
assignTo (string): This returns the email address of the user who created or is assigned as the owner of the Prospect.
Sample Response:
[
{
"id": "5ea6ff1820a3000012b795f4",
"FullName": "Rex A Jose",
"FirstName": "Rex",
"LastName": "Jose",
"MiddleName": "A",
"Account": "Payments",
"Department": "Testing",
"Company": "klenty",
"CompanyDomain": "klenty.com",
"Title": "SE",
"Location": "Tamilnadu",
"Phone": "9600137789",
"Email": "rex@klenty.com",
"TwitterId": "Twitter",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "5656",
"City": "Italy",
"Country": "Italy",
"LinkedinURL": "Linkedin@io.co",
"Tags": "paid",
"List": "leads",
"assignTo": "q1@test.com",
"Custom Fields": {
"gender": "male"
}
}
]
Get All Webhooks
This endpoint will return all the webhook events created by the user along with the webhook URL & id.
HTTP Request
Request Type: GET
https://app.klenty.com/apis/v1/user/hello@klenty.com/webhook/getall
The response includes the following values:
subscription_url (string): the URL where the event is created.
_id - Webhook id (string): the Webhook id created when the event is generated.
event (string): the event that triggers a webhook.
Sample Response:
{
"_id": "5e68951c012a6500127abc25",
"webhooks": [
{
"_id": "5ea2c55cacd65a001239a2c6",
"url": "https://webhook.site/5fa14dd0-3302-4734-bac6-74086afa898d",
"event": "reply"
},
{
"_id": "5ea2c5f1acd65a001239a2e1",
"url": "https://webhook.site/5fa14dd0-3302-4734-...",
"event": "startCadence"
}
]
}Create Prospects
This endpoint will create a Prospect based on the input, which is given as a JSON object.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/kevin@klenty.com/prospects
Input:
Email (string): the Prospect’s email id.
FirstName (string): the value for the Prospect’s first name.
Company (string): the value for the Prospect’s company name.
FullName (string): the value for the Prospect’s full name.
LastName (string): the value for the Prospect’s last name.
MiddleName (string): the value for the Prospect’s middle name.
Account (string): the value for the Prospect's Account field.
Department (string): the value for the Prospect's Department field.
CompanyDomain (string): the value for the Prospect's Company Domain field.
Title (string): the value for the Prospect's Title field.
Location (string): the value for the Prospect’s Location field.
Phone (string): the value for the Prospect’s Phone field.
TwitterId (string): the value for the Prospect’s Twitter field.
CompanyPhone (string): the value for the Prospect’s company phone field.
CompanyEmail (string): the value for the Prospect’s company email field.
LinkedinURL (string): the value for the Prospect’s LinkedIn field.
City (string): the value for the Prospect’s city field.
Country (string): the value for the Prospect’s country field.
List (string): Enter the Prospect list you want to add this Prospect to. If left empty, the Prospect will be added to the default list. If the Prospect list you enter does not exist, a new one will be created and the Prospect will be assigned to it.
Tags (string): This is used to add tags to the prospect. For multiple tags: "Tags": "Tag1|Tag2"
CustomFields (string): This is used to add custom fields to the Prospect.
Sample Input:
{
"FullName": "Rex A Jose",
"FirstName": "Rex",
"LastName": "Jose",
"MiddleName": "A",
"Account": "Payments",
"Department": "Testing",
"Company": "klenty",
"CompanyDomain": "klenty.com",
"Title": "SE",
"Location": "California",
"Phone": "+13485948395",
"Email": "rex@klenty.com",
"TwitterId": "Twitter",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "5656",
"City": "Italy",
"Country": "Italy",
"LinkedinURL": "Linkedin@io.co",
"List": "leads",
"Tags": "paid", For multiple tags: "Tags": "Tag1|Tag2"
"CustomFields" : [{"key":"gender", "value" : "male"}]
}
Response:
status (Boolean) : Returns either true or false to indicate success.
{
"status": true
}
Start Cadence
This endpoint expects an email address of the Prospect and the Cadence name as the input to add the Prospect to a Cadence.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/startcadence
Input should contain the following values:
Email (string): enter the Email id of the Prospect you want to start the Cadence for.
cadenceName (string): enter the Cadence you want to add this Prospect to.
Sample input:
{
"Email" : "steve@klenty.com",
"cadenceName" : "Holiday campaign"
}
Response:
status (Boolean) : Returns either true or false based on the outcome.
{
"status": true
}
Stop Cadence for a prospect
This endpoint expects an email address of the Prospect and the name of the Cadence it is associated with as input to stop Cadences. If the cadence name is not specified, this endpoint removes the Prospect from all the cadences.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/stopcadence
Input should contain:
Email (string): enter the Prospect’s Email id.
cadenceName (string): enter the Cadence Name from which the Prospect has to be removed.
{
"Email" : "steve@klenty.com",
"cadenceName" : "SampleCadence"
}
Response:
status (Boolean): Returns either true or false based on the outcome.
{
"status": true
}
Resume cadence
This endpoint expects an email address of a Prospect as input, to resume the Cadence that was paused for the Prospect.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hannah@klenty.com/cadences/resume
Input:
Email (string): enter the Prospect’s email id.
{
"Email" : "steve@klenty.com"
}
Response:
status (Boolean): Returns either true or false based on the outcome.
{
"status": true
}
Stop Mails
This endpoint expects an email address of a Prospect as input, to stop any scheduled emails from being sent to the Prospect.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/steve@klenty.com/stop
Input:
Email (string): enter the Prospect’s Email id.
{
"Email" : "steve@klenty.com"
}
Response:
status (Boolean): Returns either true or false based on the outcome.
{
"status": true
}
Unsubscribe Prospect
This endpoint expects an email address of a Prospect as input, to change the Prospect Status to Unsubscribed. Setting a Prospect to Unsubscribed status will prevent any future emails from being sent to them.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/steve@klenty.com/unsubscribe
Input:
Email (string): enter the email id of the Prospect you want to mark as unsubscribed.
{
"Email" : "steve@klenty..com"
}
Response:
status (Boolean): Returns either true or false based on the outcome.
{
"status": true
}Change Prospect Status to DoNotContact
This endpoint expects an email address of a Prospect as input, to change the Prospect Status to DoNotContact. Setting a Prospect to this status will prevent any future emails from being sent to them. This action is reversible i.e, prospects can be reverted from DoNotContact, allowing for the Prospect to be emailed again.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/steve@klenty.com/changeStatusToDoNotContact
Input:
Email (string): enter the email id of the Prospect you want to mark as DoNotContact.
{"Email" : "steve@klenty..com"
}
Response:
status (Boolean): Returns either true or false based on the outcome.
{"status": true
}
Revert from DoNotContact status
This endpoint expects an email address of a Prospect as input, to change the Prospect Status from DoNotContact to normal state. Reverting back from DoNotContact helps users to continue sending emails to that prospect. If the Prospect is in Not Contacted state before, when reverting DoNotContact it changes to Not Contacted else the status will be Manually Stopped.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/steve@klenty.com/revertStatusToDoNotContact
Input:
Email (string): enter the email id of the Prospect you want to revert from DoNotContact.
{"Email" : "steve@klenty..com"
}
Response:
status (Boolean): Returns either true or false based on the outcome.
{"status": true
}
Update Prospect
This endpoint will update a Prospect based on the input which is given as a JSON object.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/victor@klenty.com
Input:
Email (string): enter the Prospect’s email id.
FirstName (string): enter the Prospect’s first name.
Company (string): enter the Prospect’s company name.
FullName (string): enter the Prospect’s full name.
LastName (string): enter the Prospect’s last name.
MiddleName (string): enter the Prospect’s middle name.
Account (string): enter the account details the Prospect belongs to.
Department (string): enter the department the Prospect belongs to.
CompanyDomain (string): enter the company domain the Prospect belongs to.
Title (string): enter the title which the Prospect holds.
Location (string): enter the Prospect’s current location.
Phone (string): enter the Prospect’s phone number.
TwitterId (string): enter the Prospect’s twitter handle.
CompanyPhone (string): enter the Prospect’s company contact number.
CompanyEmail (string): enter the Prospect’s company email id.
LinkedinURL (string): enter the Prospect’s LinkedIn Public Profile URL.
City (string): enter the Prospect’s city.
Country (string): enter the Prospect’s country.
List (string): Enter the Prospect list you want to add this Prospect to. If left empty, the Prospect will be added to the default list. If the Prospect list you enter does not exist, a new one will be created and the Prospect will be assigned to it.
Tags (string): This is used to add tags to the prospect. For multiple tags: "Tags": "Tag1|Tag2"
CustomFields (string): This is used to add custom fields to the Prospect.
{
"FullName": "Rex A Jose",
"FirstName": "Rex",
"LastName": "Jose",
"MiddleName": "A",
"Account": "Payments",
"Department": "Testing",
"Company": "klenty",
"CompanyDomain": "klenty.com",
"Title": "SE",
"Location": "Tamilnadu",
"Phone": "9600137789",
"Email": "rex@klenty.com",
"TwitterId": "Twitter",
"CompanyEmail": "klenty@cc.co",
"CompanyPhone": "5656",
"City": "Italy",
"Country": "Italy",
"LinkedinURL": "Linkedin@io.co",
"List": "leads",
"Tags": "paid", For multiple tags: "Tags": "Tag1|Tag2"
"CustomFields" : [{"key":"gender", "value" : "male"}]
}
Response:
status (Boolean): Returns either true or false based on the outcome.
{
"status": true
}
Email Engagements
This endpoint expects a start date, end date, and the name of the Cadence to provide the email engagement count for that Cadence. You can also include a timestamp and date like "2020-04-01T06:30:51Z" to filter the results.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/emailEngagements
Input:
startDate (Date): The start date of the time period you want the email engagement metrics for. Format should be yyyy-mm-dd.
endDate (DATE): The end date of the time period you want the email engagement metrics for. Format should be yyyy-mm-dd.
cadenceName (string): The name of the Cadence for which you want the email engagement metrics.
{
"startDate" : "2020-04-01T06:30:51Z",
"endDate" : "2020-04-20T06:30:51Z",
"cadenceName" : "Website visitors"
}
Response:
prospectsAdded (number): The total number of Prospects added to the Cadence in the specified date range.
inCadenceCount (number): the number of Prospects who are currently in Cadence
prospectsCompleted (number): the number of Prospects who have completed the Cadence
openCount (number): The count of total email opens.
linkCount (number): The count of total link clicks.
replyCount (number): This returns the value for total replies received.
unsubscribeCount (number): This returns the number of prospects who have unsubscribed.
bounceCount (number): This returns the number of prospects for whom emails bounced.
positiveCount (number): This returns the number of replies that were marked as positive.
negativeCount (number): This returns the number of replies that were marked as negative.
Sample Response:
{
"prospectsAdded": 32,
"inCadenceCount": 2,
"prospectsCompleted": 0,
"openCount": 2,
"linkCount": 1,
"replyCount": 2,
"unsubscribeCount": 2,
"bounceCount": 5,
"positiveCount": 1,
"negativeCount": 1
}
StepWise Metric Engagement
This endpoint expects a start date, end date and the name of the Cadence to provide the stepwise metric count of that Cadence. You can also include a Timestamp along with a date like "2020-04-01T06:30:51Z" to filter the results.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/stepWiseEngagements
Input:
startDate (Date): Enter the value for the date from which you want the email stepwise metrics. Format should be yyyy-mm-dd.
endDate (DATE): Enter the value for the date until which you want the email stepwise metrics. Format should be yyyy-mm-dd.
cadenceName (string): Enter the name of the Cadence for which you want the stepwise metrics.
{
"startDate" : "2020-04-01T06:30:51Z",
"endDate" : "2020-04-20T06:30:51Z",
"cadenceName" : "Website visitors"
}
Response:
stepNumber (number): This returns the step number for all the steps present in Cadence.
stepType (string): This returns the type of this step, if it is an email, task or call.
openCount (number): This returns the count of emails that were opened in this step.
replyCount (number): This returns the count of replies received.
positiveReply (number): This returns the count of replies that were marked as positive.
negativeReply (number): This returns the count of replies that were marked as negative.
positiveReplyPercent (number): This returns the percentage of positive replies received.
negativeReplyPercent (number): This returns the percentage of negative replies received.
linkCount (number) : This returns the count for total link clicks.
mailCount (number): This returns the count for emails sent in that step.
openPercent (number): This returns the percentage of emails opened.
replyPercent (number): This returns the percentage of replies received.
LinkPercent (number): This returns the percentage of links clicked.
Completed (number): This returns the number of prospects who have completed the step.
taskCount (number): This returns the number of tasks scheduled if this step is a task.
callCount (number): This returns the number of calls scheduled if this step is a call.
completedCalls (number): This returns the percentage value of calls that were completed, if this step is a call.
templateName (string): This returns the value for the template name if it is an email step.
subject (string): This returns the value for the subject line used, if it is an email step.
snippet (string): This returns the first few lines of the email content.
Sample Response:
{
"stepNumber": 1,
"stepType": "mail",
"openCount": 1,
"replyCount": 1,
"positiveReply": 0,
"negetiveReply": 0,
"positiveReplyPercent": 0,
"negetiveReplyPercent": 0,
"linkCount": 0,
"mailCount": 8,
"openPercent": 13,
"replyPercent": 13,
"linkPercent": 0,
"completed": 0,
"taskCount": 0,
"callCount": 0,
"completedCalls": 0,
"options": [
{
"option": 1,
"openCount": 1,
"replyCount": 1,
"linkCount": 0,
"mailCount": 8,
"openPercent": 13,
"replyPercent": 13,
"positiveReply": 0,
"negetiveReply": 0,
"positiveReplyPercent": 0,
"negetiveReplyPercent": 0,
"linkPercent": 0,
"templateName": "Follow Ups",
"subject": "Enter your subject line here...",
"snippet": "This is the first step of your..."
},
{
"option": 2,
"openCount": 0,
"replyCount": 0,
"linkCount": 0,
"mailCount": 0,
"openPercent": 0,
"replyPercent": 0,
"positiveReply": 0,
"negetiveReply": 0,
"positiveReplyPercent": 0,
"negetiveReplyPercent": 0,
"linkPercent": 0,
"subject": "Enter your subject line here...",
"snippet": "This is the first step of your..."
}
]
},
{
"stepNumber": 2,
"stepType": "mail",
"openCount": 0,
"replyCount": 0,
"positiveReply": 0,
"negetiveReply": 0,
"positiveReplyPercent": 0,
"negetiveReplyPercent": 0,
"linkCount": 0,
"mailCount": 1,
"openPercent": 0,
"replyPercent": 0,
"linkPercent": 0,
"completed": 0,
"taskCount": 0,
"callCount": 0,
"completedCalls": 0,
"options": [
{
"option": 1,
"openCount": 0,
"replyCount": 0,
"linkCount": 0,
"mailCount": 1,
"openPercent": 0,
"replyPercent": 0,
"positiveReply": 0,
"negetiveReply": 0,
"positiveReplyPercent": 0,
"negetiveReplyPercent": 0,
"linkPercent": 0,
"subject": "Follow-up email",
"snippet": " This is the second step (foll..."
}
]
}Add a Webhook
This endpoint expects the subscription URL and the events for which you are creating a webhook and returns the value of the webhook created.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/zapier/hooks
Input:
The JSON input can have the events listed as the input.
event (string): Enter the event that will trigger the webhook [Accepted events are: reply, cadenceFirstReply, sendProspect, startCadence, completeCadence, onMailBounce, open, click, unsubscribe].
subscription_url (string): the URL where you’d like the event to be created.
{
"subscription_url" : "www.klenty.com/analytics",
"event" : "completeCadence"
}
Response:
event (string): the event that will trigger a webhook.
url (string): the URL where the event will be created.
_id - Webhook id (string): the Webhook id created when the event is generated.
Sample Response:
{
"_id": "5e9da4ff65b8860012669444",
"url": "www.klenty.com/analytics",
"event": "completecadence"
}Update a Webhook
This endpoint expects the subscription URL, _id of the webhook and the events that trigger the webhook.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/webhook/update
Input:
The JSON input can have the events listed as the input.
event (string): the event that will replace the existing for this webhook [Accepted events are: reply, cadenceFirstReply, sendProspect, prospect, startCadence, completeCadence, onMailBounce, open, click, unsubscribe].
subscription_url (string): the URL where the event is created.
_id - Webhook id (string): the Webhook id created when the event is generated.
{
"_id": "5e9f360ec0d425001292903b",
"subscription_url" : "www.klenty.com/analytics",
"event" : "unsubscribe"
}Response:
status (Boolean): Returns either true or false based on the outcome.
{
"status": true
}
Delete Webhook
This endpoint expects the webhook id which is to be deleted and returns a boolean value based on success or failure.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/webhook/delete
Input:
The JSON input can have the events listed as the input.
webhookId (string): This is the unique id created when a webhook is triggered.
{
"webhookId": "5e9eadce9bd3bc0012b38601"
}Response:
status (Boolean): Returns either true or false based on the outcome.
{
"status": true
}Add Prospect to List
This endpoint expects an email and a list name and returns a boolean value based on success or failure. List will not be added if the prospect already exists in Klenty.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects
Input:
Email (string): This is the Prospect’s email id.
FirstName (string): This is the Prospect’s first name.
List (string): This is the list you want to add the Prospect to.
Sample Input:
{
"Email" : "tony@klenty.com",
"FirstName" : "Tony",
"List": "Pearson"
}
Response:
status (Boolean): Returns either true or false based on the outcome.
Sample Response:
{
"status": true
}
Add Tags to a Prospect
This endpoint expects a Prospect’s email address and a Tag name and returns a boolean value based on success or failure. Tags will not be added if the prospect already exists in Klenty.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects
Input:
Email (string): This is the Prospect’s email id.
FirstName (string): This is the Prospect’s first name.
Tags (string): This is the name of the tag you want to assign to the prospect.
Sample Input:
{
"Email" : "tom@klenty.com",
"FirstName" : "Tom",
"Tags": "ConnectLater"
}Pro Tip: For multiple tags: "Tags": "Tag1|Tag2"
Response:
status (Boolean): Returns either true or false based on the values.
Sample Response:
{
"status": true
}
Add value to a Prospect’s Custom Field
This endpoint expects the email id of the prospect and the list of custom fields for which you want to add values, and returns a boolean value that is either true or false.
HTTP Request
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects
Input:
Email (string): This is the Prospect’s email id.
FirstName (string): This is the Prospect’s first name.
CustomFields (string): This is a list of custom fields along with the values that should be added.
Sample Input:
{
"Email" : "sheindrick9@klenty.com",
"FirstName":"sheindrick",
"CustomFields":[{"key":"key1","value":"value1"}]
}Response:
status (Boolean): Returns either true or false based on the outcome.
Sample Response:
{
"status": true
}
Bulk Add Prospects
This endpoint can create up to 100 Prospects based on the input which is given as a JSON object. Input is passed as an array and a comma separates each Prospect details. If it is a new Prospect, it gets added to Klenty and you receive the response “Prospect added successfully”. If the prospect already exists in Klenty, you will receive the response “Prospect already exists in Klenty”.
HTTP REQUEST
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects
Input:
Email (string): enter the Prospect’s email id.
FirstName (string): enter the Prospect’s first name.
Company (string): enter the Prospect’s company name.
FullName (string): enter the Prospect’s full name.
LastName (string): enter the Prospect’s last name.
MiddleName (string): enter the Prospect’s middle name.
Account (string): enter the account details the Prospect belongs to.
Department (string): enter the department the Prospect belongs to.
CompanyDomain (string): enter the company domain the Prospect belongs to.
Title (string): enter the title which the Prospect holds.
Location (string): enter the Prospect’s current location.
Phone (string): enter the Prospect’s phone number.
TwitterId (string): enter the Prospect’s twitter handle.
CompanyPhone (string): enter the Prospect’s company contact number.
CompanyEmail (string): enter the Prospect’s company email id.
LinkedinURL (string): enter the Prospect’s LinkedIn Public Profile URL.
City (string): enter the Prospect’s city.
Country (string): enter the Prospect’s country.
List (string): Enter the Prospect list you want to add this Prospect to. If left empty, the Prospect will be added to the default list. If the Prospect list you enter does not exist, a new one will be created and the Prospect will be assigned to it.
Tags (string): This is used to add tags to the prospect.
CustomFields (string): This is used to add custom fields to the Prospect.
Sample Input:
[
{
"Email":"raj@klenty.com",
"FirstName" : "Raj",
"Phone" : "951357654",
"FullName" : "Raj Krishna",
"LastName" : "Krishna",
"Department" : "Testing1",
"CompanyDomain" : "klenty1.com",
"CompanyURL" : "www.klenty1.com",
"Title" : "Tester1",
"Location" : "Chennai Area1",
"City" : "Chennai1",
"Country" : "India1",
"CustomFields" : [{"key":"key1", "value" : "value1"}]
},
{
"Email":"ram@klenty.com",
"FirstName" : "Ram",
"Phone" : "951357654",
"FullName" : "Ram Nath",
"LastName" : "Nath",
"Department" : "Testing1",
"CompanyDomain" : "klenty1.com",
"CompanyURL" : "www.klenty1.com",
"Title" : "Tester1",
"Location" : "Chennai Area1",
"City" : "Chennai1",
"Country" : "India1"
}
]
Response:
status (Boolean): Returns either true or false based on the outcome.
details (string): Returns the Prospect’s email id and outcome.
Sample Response:
{
"status": true,
"details": [
{
"prospect": "raj@klenty.com",
"status": "Prospect added successfully"
},
{
"prospect": "ram@klenty.com",
"status": "Prospect already exists in Klenty."
}
]
}
Remove Tags
This endpoint will help you remove tags that have been added to a Prospect in Klenty.
HTTP REQUEST
Request Type: POST
https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/tom@klenty.com/removeTags
Input:
tag (string): enter the tag which needs to be removed from the Prospect. You can include multiple tags separated by a comma.
Sample Input:
{
"tag" : ["tag1","tag2"]
}Response:
status (Boolean) : Returns either true or false based on the outcome.
Sample Response:
{
"status": true
}