Klenty Glossary 

Haven’t used Klenty before? A collection of terms frequently used in Klenty to help you get started. 

-> Cadence - Cadence is a sequence of email and follow-ups that you create to reach out to Prospects.

-> Prospect - Prospects are people you will be reaching out to.  

-> Standard Fields - Standard fields are the default fields for Prospects in Klenty that you can use to personalize your emails. 

-> Custom Fields - Custom fields are additional fields for Prospects you can create in Klenty for advanced personalization. 

-> List - When you upload prospects, organise them into lists to easily segment and track them

-> Tags - Use Tags to easily filter / search for prospects. 

-> Journey - Journey allows you to set up advanced conditional follow-ups based on how Prospects engage with your emails. (This is a beta features and is only available
for select Beta customers)

-----------------------------------------------------------------------------------------------------------------------------

(API) Key to your quest - 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

AUTHENTICATION

The Klenty API follows the REST paradigm and requires you to have a unique API Key.  

URI PARAMETER

All API request URLs start with:

https://app.klenty.com/apis/v1/user/<username>/

In the above http request, username is a URI parameter.

QUERY PARAMETER

Anything you give after '?' in the URI are called query parameters.

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?listName=csvlist1

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

The language we speak!

● 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 particular prospect. 

Request Type: GET 

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?Email=steve@klenty.com

RESPONSE

  • Prospect id (string): This returns the value of the Prospect’s unique id. 
  • Email (string): This returns the value for Prospect’s email id. 
  • First name (string): This returns the value for Prospect’s first name.
  • Company (string): This returns the value for Prospect’s company. 
  • Phone (string): This returns the value of the Prospect’s phone number. 
  • Full Name (string): This returns the value for Prospect’s full name. 
  • Last Name (string): This returns the value for Prospect’s last name. 
  • Location (string): This returns the value for the Prospect’s location including their Country, City based on the details given.
  • List (string): This returns the value for Prospect’s list they are classified under, if any. 
  • Tags (string): This returns the value for the Prospect’s tag they are grouped under, if any.  

  {

"Id" : "58df455871e0960b001f8c6b",

"Country" : "USA,

"City" : "New York",

"CompanyPhone" : "030-22558899",

"CompanyEmail" : "steve@klenty.com",

"Email" : "steve@klenty.com",

"Phone" : "987456321",

"Title" : "Quality assurance specialist",

"CompanyDomain" : "klenty.com",

"Company" : "Klenty",

"Department" "Software testing",

"LastName" : "Davis",

"FirstName" : "Steve",

"FullName" : "Steve Davis",

}

Get prospect status by Email

This endpoint expects an email address , and will return an object containing status of that prospect.

HTTP Request

Request Type: GET

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/steve@klenty.com/status

RESPONSE

{

"cadenceStatus" : "No active cadence",

"prospectStatus" : "Not Contacted"

}

Get Company cadences

This endpoint expects an email address of one of the team members, and will return an object containing all cadences of that team.

HTTP Request

Request Type: GET

https://app.klenty.com/apis/v1/user/helen@klenty.com/cadences

RESPONSE

  • Cadence name (string): This returns the value of all the created Cadence for a particular company. 

[

    {

        "id": "outbound campaign",

        "name": "outbound campaign"

    },

    {

        "id": "website visitors",

        "name": "website visitors"

    },

    {

        "id": "reconnecting with old prospects",

        "name": "reconnecting with old prospects"

    },

    {

        "id": "SaaStr attendees",

        "name": "SaaStr attendees"

    }

]

Get User cadences

This endpoint expects a username of the user as an input, and will return an object containing cadences of that username.

HTTP Request

Request Type: GET 

https://app.klenty.com/apis/v1/user/hello@klenty.com/cadences?username=/hello@klenty.com

 

RESPONSE

  • Cadence name (string): This returns the value for all the Cadences created by a user.  

[

    {

        "id": "New leads",

        "name": "New leads"

    },

    {

        "id": "July ads",

        "name": "July ads"

    }

]

Get Lists

This endpoint expects an email address of a user, and will return an object containing the lists created or imported by that user

HTTP Request

Request Type: GET

https://app.klenty.com/apis/v1/user/hello@klenty.com/lists

RESPONSE

  • Id (string): This returns the value of the unique id of the Prospect. 
  • List name (string): This returns the value of the list names of the Prospect. 

   {

"Id" : "5860bcb7ca84a10b00bff3c6",

"name": "North America"

}

   {

"Id" : "58dcc484cda2d03206eebb79",

"name": "Europe"

}  

   {

"Id" : "58ddfa7fcda2d03206eee7d2",

"name": "Australia"

}

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

RESPONSE

  • Cadence status (string): This returns the value of whether there is any active Cadence for the particular Prospect. 
  • Prospect status (string): This returns the value for the status of a particular Prospect. 

{

"cadenceStatus" : "No active cadence",

"prospectStatus" : "Not Contacted"

}

Get prospect by List

This endpoint expects the list name of a user and will return an object containing all the attributes in the list. 

HTTP Request

Request Type: GET

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?listName=Australia

RESPONSE

  • Prospect id (string): This returns the value of the unique prospect id. 
  • List (string): This returns the value of the list name, if given or default otherwise.
  • Tags (strings): This returns the value of the tags if any.   
  • Email (string): This returns the value for Prospect’s email id. 
  • First name (string): This returns the value for Prospect’s first name.
  • Company (string): This returns the value for Prospect’s company. 
  • Full Name (string): This returns the value for Prospect’s full name. 
  • Last Name (string): This returns the value for Prospect’s last name. 
  • List (string): This returns the value for Prospect’s list they are classified under. 
  • Assign to (string): This returns the value of your email id. 

[

    {

        "id": "5d33f87a2c9a9a1100f7aa32",

        "List": "default",

        "Tags": [

            "hotlead"

        ],

        "Email": "eden@zoom.com",

        "Company": "Zoom",

        "LastName": "Hazard",

        "FirstName": "Eden",

        "FullName": "Eden Hazard",

        "assignTo": "kevin@klenty.com",

        "listName": "Australia"

    },

    {

        "id": "5d33f92997d763110004e640",

        "List": "5d33f83bcd22d323e631388b",

        "Tags": [

            "meeting"

        ],

        "Email": "neesham@proaqua.com",

        "Company": "Pro Aqua Solutions",

        "LastName": "Jr.",

        "FirstName": "Neesham",

        "FullName": "Neesham Jr.",

        "assignTo": "kevin@klenty.com",

        "listName": "Australia"

    }

]

Get prospect details with Custom fields

This endpoint will return the value of custom fields for the specified prospect.

HTTP Request

Request Type: GET

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects?Email=noah@firstcry.com&customFields=true

RESPONSE

  • Id (string): This returns the value for the specified prospect’s id which is their unique identifier.  
  • List (string): This returns the value for Prospect’s list they are classified under, if any. 
  • Tags (string): This returns the value for the Prospect’s tag they are grouped under, if any. 
  • Location (string): This returns the value for the Prospect’s location including their Country, City based on the details given. 
  • Name (string): This returns the value for the Prospect’s name such as first name, last name and full name. 
  • Custom fields (string): This returns the values for various custom fields given. 
  • Assign to (string): This returns the value of your email id. 

[

{

        "id": "5d33f92997d763110004e640",

        "List": "5d3f15542b6e53ed164c9c05",

        "Tags": [

            "leadgeneration"

        ],

        "Country": "France",

        "City": "Paris",

        "Email": "ariana@fashion.com",

        "Company": "",

        "LastName": "Huffington",

        "FirstName": "Ariana",

        "FullName": "Ariana Huffington",

        "Custom Fields": {

            "Club": "PSG",

            "Dream club": "Barca"

        },

        "assignTo": "learn@klenty.com",

        "listName": "Europe"

}

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): This is used to get the value of Prospect’s email id. 
  • First name (string): This is used to get the value of Prospect’s first name.
  • Company (string): This is used to get the value of Prospect’s company. 
  • Full Name (string): This is used to get the value of Prospect’s full name. 
  • Last Name (string): This is used to get the value of Prospect’s last name. 
  • City (string): This is used to get the value ofProspect’s city. 
  • Country (string): This is used to get the value of Prospect’s country. 
  • List: (string) This is used to get the value of the list name. 
  • Tags: (string) This is used to get the value of Prospect’s tags.  

{"Email":"Ariana@fashionpalace.com",

 "FirstName":"Ariana",

 "Company":"Klenty",

 "FullName":"Ariana Huffington",

 "LastName":"Huffington",

 "City":"Paris",

 "Country":"France",

 "List":"Europe",

 "Tags":"leadgeneration"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Start cadence

This endpoint expects an email address of the prospect and the cadence name as the input, to start a cadence for a prospect.

Request Type: HTTP Request

POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/startcadence

INPUT 

  • Email (string): This is used to enter the value for Prospect’s email id for whom you want to start a Cadence. 
  • Cadence Name (string): This is used to enter the value for the Cadence name you want to start. 

{

"Email" : "steve@klenty.com",

"cadenceName" : "Holiday campaign"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Stop cadence

This endpoint expects an email address of the prospect as input to stop your Cadences. 

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/stopcadence

INPUT : 

  • Email (string): This is used to enter your email id. 

{

"Email" : "steve@klenty.com"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Resume cadence

This endpoint expects an email address of a prospect as input, to resume the cadence for that prospect.

HTTP Request

Request Type: POST https://app.klenty.com/apis/v1/user/hannah@klenty.com/cadences/resume

INPUT :

  • Email (string): This is used to enter your email id. 

{

"Email" : "steve@klenty.com"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Stop Mails

This endpoint expects an email address of a prospect as input, to stop the mails from going out for that prospect.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/stop

INPUT :

  • Email (string): This is used to enter your email id. 

{

"Email" : "steve@klenty.com"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Unsubscribe prospect

This endpoint expects an email address of a prospect as input, to change prospect status to unsubscribe and remove all scheduled mails to that prospect.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/prospects/unsubscribe

INPUT :

  • Email (string): This is used to enter your Prospect’s email id that you want to mark as unsubcribed. 

 {

"Email" : "patrick@zodiac.com"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"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@edtech.com 

INPUT 

  • Email (string): This returns the value for Prospect’s email id. 
  • First name (string): This returns the value for Prospect’s first name.
  • Company (string): This returns the value for Prospect’s company. 
  • Full Name (string): This returns the value for Prospect’s full name. 
  • Last Name (string): This returns the value for Prospect’s last name. 
  • Location (string): This returns the value for the Prospect’s location including their Country, City based on the details given.
  • List (string): This returns the value for Prospect’s list they are classified under, if any. 
  • Tags (string): This returns the value for the Prospect’s tag they are grouped under, if any.  

{

  "Email" : "victor@edtech.com",

  "FirstName" : "Victor",

  "Company" : "Edtech",

  "FullName" : "Victor Kramer",

  "LastName" : "Kramer",

  "CompanyDomain" : "edtech.com",

  "Title" : "Business Development",

  "City" : "Berlin",

  "Country" : "Germany",

“List” :          “Europe”,

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Cohort Metrics

This endpoint expects a start date, end date and the name of the cadence to give the metric count with respect to that cadence.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/dailyCohortMetrics

INPUT 

  • Start Date (Date): Enter the value for the date from which you want the Cohort metrics. It is in the format yyyy-mm-dd.
  • End Date (DATE): Enter the value for the date until which you want the Cohort metrics. It is in the format yyyy-mm-dd.
  • Cadence name (string): Enter the name of the Cadence for which you want the cohort metrics. 

{

"startDate" : "2019-07-01T06:30:51Z",

"endDate" : "2019-08-20T06:30:51Z",

"cadenceName" : "Holiday Campaign"

}

Response

  • Start date: This returns the value of the start date for the given time period. 
  • In Cadence: This returns the value of how many Cadences are currently live in the time period. 
  • Completed without reply: This returns the value of the number of Cadences that are completed without reply. 
  • Manually stopped: This returns the value of the Cadences manually stopped by you. 
  • Unsubscribed: This returns the value of the prospects that were marked unsubscribed.   
  • Bounced: This returns the value of emails that were bounced. 
  • Replied: This returns the value for Cadences that were stopped because the prospect replied. 
  • Replied stopped: This returns the value of Cadences that were stopped for all Prospects from the same domain (If enabled in the Safety settings)  
  • Auto reply stopped: This returns the value of Cadences that were stopped because there was an auto-reply message from the Prospect. Example: Out-of-office examples. 
  • Task Stopped: This returns the value for tasks that are completed. 
  • End date: This returns the value of the end date for the given time period.

 "July 01": 

{

"In cadence" : 0,

"Completed Without Reply" : 0,

"Manually Stopped" : 0,

"Unsubscribed" : 0,

"Bounced" : 2,

“Replied” : 1,

"Replied Stopped" : 0,

"Auto Reply Stopped" : 0,

"Task Stopped" : 0

}

{

"Aug 20": 

     {

"In cadence" : 2,

"Completed Without Reply" : 0,

"Manually Stopped" : 1,

"Unsubscribed" : 0,

"Bounced" : 0,

"Replied Stopped" : 0,

"Auto Reply Stopped" : 0,

"Task Stopped" : 0

}

Email Engagements

This endpoint expects a start date, end date and the name of the cadence to give the email engagement count with respect to that cadence.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/emailEngagements

INPUT 

  • Start Date (Date): Enter the value for the date from which you want the email engagement metrics. It is in the format yyyy-mm-dd.
  • End Date (DATE): Enter the value for the date until which you want the email engagement metrics. It is in the format yyyy-mm-dd.
  • Cadence name (string): Enter the name of the Cadence for which you want the email engagement metrics. 

{

"startDate" : "2019-07-01T06:30:51Z",

"endDate" : "2019-07-20T06:30:51Z",

"cadenceName" : "Website visitors"

}

Response

  • Mails sent: This returns the value for emails sent.
  • Unique Mail opens: This returns the value for unique opens for your email. 
  • Unique link clicks: This returns the value for unique link clicks. 
  • Unique replies: This returns the value for emails with unique replies count. 
  • Bounces: This returns the value for emails that were bounced.
  • Unsubscribed: This returns the value for emails that were unsubcribed. 
  • Total opens: This returns the value for total email opens. 
  • Total replies: This returns the value for total replies received. 
  • Total link clicks: his returns the value for total link clicks. 

{

"mailsSentCount" : 62,

"openedMailCount" : 35,

"clickedMailCount" : 13,

"repliedMailCount" : 0,

"bouncedMailCount" : 6,

"unsubscribedMailCount" : 0,

"totalOpenCount" : 49,

"totalReplyCount" : 34,

"totalClickCount" : 0

}

StepWise Metric Engagement

This endpoint expects a start date, end date and the name of the cadence to give the stepwise metric count with respect to that cadence.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/stepWiseEngagements

INPUT 

  • Start Date (Date): Enter the value for the date from which you want the email stepwise metrics. It is in the format yyyy-mm-dd.
  • End Date (DATE): Enter the value for the date until which you want the email stepwise metrics. It is in the format yyyy-mm-dd.
  • Cadence name (string): Enter the name of the Cadence for which you want the stepwise metrics. 

{

"startDate" : "2019-07-01T06:30:51Z",

"endDate" : "2019-07-20T06:30:51Z",

"cadenceName" : "Website visitors"

}

Response

  • Step Number: This returns the value for the current step in progress.
  • Step type: This returns the value of whether the given step is an email, task or call. 
  • Total opens: This returns the value for total email opens. 
  • Total replies: This returns the value for total replies received. 
  • Total link clicks: his returns the value for total link clicks. 
  • Mails sent: This returns the value for emails sent in that step. 
  • Completed: This returns the value for tasks that are completed in the step.
  • Overdue: This returns the value for tasks that are overdue in the step.
  • Upcoming: This returns the value for tasks that are upcoming. 
  • Subject line: This returns the value for the subject line used, if it is an email. 
  • Template name: This returns the value for the template name if it is an email. 

{

"stepNumber" : 1,

"stepType" : "mail",

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 1,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"options": [ 

        {

"Option" : 1,

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 1,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"Subject" : "Looking for an email solution?",

"templateName" : "website visitors"

}

 

{

"Option" : 2,

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 0,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"Subject" : "Continuing from live chat",

"templateName" : "followup"

          } 

{

"Option" : 3,

"openCount" : 0,

"replyCount" : 0,

"linkCount" : 0,

"mailCount" : 0,

"Completed" : 0,

"Overdue" : 0,

"Upcoming" : 0,

"Subject" : "Book a demo",

"templateName" : "Meeting"

}

Add a Webhook

This endpoint expects the user’s email address 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 either of the four events listed as the input.

  • Events (string): This returns the value of the events that will trigger a webhook
  • Webhook URL (string): This returns the value of the URL where the event is created. 

[
reply,

sendprospect,

startcadence,

completecadence

]

{

"Subscription_url" : "wwww.klenty.com/analytics",

"Event" : "startcadence"

}

Response

  • Events (string): This returns the value of the events that will trigger a webhook
  • Webhook URL (string): This returns the value of the URL where the event is created. 

{

"Event" : "startcadence",

"Url" : "wwww.klenty.com/analytics",

"_id" : "58df9cddbee1650b008214b6"

}

Add Lists

This endpoint expects and email and a list name 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/prospects

INPUT 

  • Email (string): This is the value used for Prospect’s email id. 
  • First name (string): This is the value used for Prospect’s first name.
  • Lists (string): This is the value used for Prospect’s list they are classified under. 

{

  "Email" : "tony@medhelp.com",

  "FirstName" : "Tony",

“List” : “Pearson”

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Add Tags

This endpoint expects and email and a list name 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/prospects

INPUT

  • Email (string): This is the value used for Prospect’s email id. 
  • First name (string): This is the value used for Prospect’s first name.
  • Tags (string): This is the value used for Prospect’s tags they are classified under. 

{

  "Email" : "tony@medhelp.com",

  "FirstName" : "Tony",

“Tags” : “connectlater”

}

For multiple tags “Tags” :   “tag1|tag2”

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Add Custom Fields

This endpoint expects the email id, the first name of the prospect and the list of custom fields you want to add 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 returns the value for Prospect’s email id. 
  • First name (string): This returns the value for Prospect’s first name.
  • Custom fields (string): This returns the value for all the custom fields used for that prospect. 

{

  "Email" : "tony@medhelp.com",

  "FirstName" : "Tony",

“CustomFields” : [{“key”:”Last contact”, “value” : “value1”}, {“key”:”State”, “value” : “value2”},...........................  ]

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Get User Journeys

This endpoint expects a username of the user as an input, and will return an object containing journeys of that username.

HTTP Request

Request Type: GET 

https://app.klenty.com/apis/v1/user/hello@klenty.com/journeys?username=bruce@wayneenterprises.com

RESPONSE

  • Journey name (string): This returns a list of values of all the journeys created for a particular prospect. 

[

  “Churned users feedback”,

“Final follow up”

]

Get Company Journeys

This endpoint expects an email address of one of the team members, and will return an object containing all journeys of that team.

HTTP Request

Request Type: GET

https://app.klenty.com/apis/v1/user/hello@klenty.com/Journeys

RESPONSE

  • Journey name (string): This returns a list of values of all the journeys created for all the Prospects of a company.  

  [

  “Outbound campaign”,

“Inbound leads”,

“Reconnect later”

]

Start Journeys

This endpoint expects an email address of the prospect and the journey name as the input, to start a journey for a prospect. 

To specify a start time for the Journey, use scheduledDate and provide the time in UTC. 

If scheduledDate is not provided, the Journey will be started immediately for the prospect.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/journey/start

INPUT

  • Email (string): This returns the value for your email id. 
  • Journey name (string): This returns the value for the journey you want to start. 
  • Scheduled date: (date): This returns the value for the scheduled date of the journey.    

.{

"Email" : "hello@klenty.com",

"journeyName" : "Outbound campaign",

"scheduledDate" : "2019-08-01T06:30:51Z"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Resume Journeys

This endpoint expects an email address of a prospect as input, to resume the journey for that prospect.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/journey/resume

INPUT 

{

"Email" : "hello@klenty.com"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Stop Journeys

This endpoint expects an email address of the prospect as input, to stop the journey for that prospect.

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/user/hello@klenty.com/journey/stop

INPUT  

  • Email (string): This returns the value for your email id. 

{

"Email" : "hello@klenty.com"

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"Status" : true

}

Bulk Add prospects

This endpoint will create less than 100 prospects 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

INPUT 

  • Email (string): This returns the value for Prospect’s email id. 
  • First name (string): This returns the value for Prospect’s first name.
  • Company (string): This returns the value for Prospect’s company. 
  • Full Name (string): This returns the value for Prospect’s full name. 
  • Last Name (string): This returns the value for Prospect’s last name. 
  • Location (string): This returns the value for the Prospect’s location including their Country, City based on the details given.
  • Title (string): This returns the value for the Prospect’s title.  
  • List (string): This returns the value for Prospect’s list they are classified under. 
  • Tags (string): This returns the value for the Prospect’s tag they are grouped under.

 [

 {

  "Email":"tony@medhelp.com",

  "FirstName" : "Tony",

  "FullName" : "Tony Pearson",

  "LastName" : "Pearson",

 "CompanyDomain" : "medhelp.com",

  "Title" : "Business Development",

  "City" : "Berlin",

 "Country" : "Germany

  }

]

Response

  • Status (strings): This value returns whether the bulk import was successful or not. 

{

"status": "Bulk Import started Successfully"

}

REMOVE TAGS

This endpoint will help you remove multiple or single tags linked with your prospect in klenty

HTTP Request

Request Type: POST

https://app.klenty.com/apis/v1/hello@klenty.com/prospects/zayn@marksolutions.com/removeTags

INPUT 

  • Tags (Strings): This is used to enter the values of tags that you want to remove.  

{

  "tag" : ["city","reconnect","meeting,"]

}

Response

  • Status (Boolean) :  Returns either true or false based on the values. 

{

"status": true

}

-----------------------------------------------------------------------------------------------------------------------------

Did this answer your question?