Klenty
App · 24 actions
Work with your Klenty sales engagement: add, update and look up prospects, start, stop and resume cadences, mark prospects Do Not Contact, read cadence engagement and call reports, and manage webhooks.
Actions
| Action | What it does |
|---|---|
| Add prospect | Add a prospect to Klenty, optionally into a list, with tags and custom fields. |
| Add prospects in bulk | Add up to 100 prospects at once from a list of rows, such as the rows of an earlier step. |
| Create webhook | Have Klenty send one kind of event (a reply, an open, a bounce and so on) to an https address. |
| Delete webhook | Delete a webhook so Klenty stops sending to it. |
| Get cadence engagement | Totals for one cadence between two days: prospects added, opens, clicks, replies, bounces and unsubscribes. |
| Get cadence engagement by step | A cadence's results step by step between two days: emails sent, opens, clicks and replies for each step. |
| Get prospect | Get one prospect by email: name, company, list, tags and owner, and their custom fields if you ask for them. |
| Get prospect status | Check where a prospect stands: their status and their cadence status, such as In Cadence. |
| List cadences | Get the company's cadences. |
| List calls | Get completed calls made from Klenty between two days, which must be within the last 30 days. |
| List lists | Get the account's prospect lists. |
| List prospects changed between dates | Get the prospects that were changed in Klenty between two days. |
| List prospects created between dates | Get the prospects added to Klenty between two days. |
| List prospects in a list | Get the prospects in one list, a page at a time (up to 1000 a page). |
| List webhooks | Get the account's webhooks with their events and addresses. |
| Mark prospect Do Not Contact | Stop all future emails to a prospect by marking them Do Not Contact. |
| Remove tags from prospect | Take one or more tags off a prospect. |
| Resume cadence | Resume a prospect's paused cadence. |
| Revert Do Not Contact | Take a prospect off Do Not Contact. |
| Start cadence | Start a cadence for a prospect who is already in Klenty. |
| Stop cadence | Take a prospect out of a cadence. |
| Stop prospect's emails | Stop the emails scheduled for a prospect. |
| Update prospect | Change a prospect's details, list, tags, custom fields or outcome. |
| Update webhook | Change the event and address of a webhook. |
Add prospect
Add a prospect to Klenty, optionally into a list, with tags and custom fields. A prospect already in Klenty is not changed; use 'Update prospect' for that.
Inputs
- Email
emailtextRequired - The prospect's email address.
- First name
first_nametext - The prospect's first name.
- Last name
last_nametext - The prospect's last name.
- Company
companytext - The company they work for.
- Job title
titletext - Their job title.
- Phone
phonetext - Their phone number.
- Department
departmenttext - Their department.
- Company website
company_domaintext - The company's domain.
- LinkedIn URL
linkedin_urltext - The link to their LinkedIn profile.
- City
citytext - Their city.
- Country
countrytext - Their country.
- Location
locationtext - Their location as one line.
- List
list_nametext - The list to put the prospect in.
- Tags
tagslist - Tags to set on the prospect, one per row.
- Custom fields
custom_fieldsobject - Your own Klenty fields: each field's name with its value.
- Owner
ownertext - The email address of the Klenty user who owns the prospect. Leave empty to own it yourself.
Outputs
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"email": "jo@example.com",
"success": true
}Add prospects in bulk
Add up to 100 prospects at once from a list of rows, such as the rows of an earlier step. Each row needs an email and may have first_name, last_name, company, title, phone, list_name, tags, custom_fields and the other prospect fields. Says which were added and which already existed.
Inputs
- Prospects
prospectslistRequired - The prospects, as a list of rows with an email each.
Outputs
addednumber- How many were added
already_existingnumber- How many were already in Klenty
countnumber- How many prospects were sent
resultslist- What Klenty said about each prospect
successtrue/false- True once Klenty has done it
Example output
{
"added": 1,
"already_existing": 0,
"count": 1,
"results": [
{
"email": "jo@example.com",
"status": "prospect added successfully"
}
],
"success": true
}Create webhook
Have Klenty send one kind of event (a reply, an open, a bounce and so on) to an https address.
Inputs
- Event
eventtextRequired - What makes Klenty send a notification.One of:
reply(A prospect replies),cadenceFirstReply(A prospect replies for the first time in a cadence),sendProspect(A prospect is sent to another app),startCadence(A prospect starts a cadence),completeCadence(A prospect completes a cadence),onMailBounce(An email bounces),open(An email is opened),click(A link is clicked),unsubscribe(A prospect unsubscribes). - Address
urltextRequired - The https:// address Klenty sends notifications to.
Outputs
webhookobject- The webhook
Example output
{
"webhook": {
"event": "reply",
"id": "5e9f360ec0d425001292903b",
"url": "https://example.com/klenty"
}
}Delete webhook
Delete a webhook so Klenty stops sending to it.
Inputs
- Webhook
webhook_idtextRequired - The webhook. Pick one, or give its id from an earlier step.
Outputs
successtrue/false- True once Klenty has done it
webhook_idtext- The webhook deleted
Example output
{
"success": true,
"webhook_id": "5e9f360ec0d425001292903b"
}Get cadence engagement
Totals for one cadence between two days: prospects added, opens, clicks, replies, bounces and unsubscribes.
Inputs
- Cadence
cadence_nametextRequired - The cadence. Pick one, or give its name from an earlier step.
- From
start_datedateRequired - The first day to report on.
- Until
end_datedateRequired - The last day to report on.
Outputs
engagementsobject- The cadence's totals
Example output
{
"engagements": {
"bounceCount": 1,
"inCadenceCount": 12,
"linkCount": 4,
"negativeCount": 1,
"openCount": 30,
"positiveCount": 2,
"prospectsAdded": 20,
"prospectsCompleted": 5,
"replyCount": 3,
"unsubscribeCount": 0
}
}Get cadence engagement by step
A cadence's results step by step between two days: emails sent, opens, clicks and replies for each step.
Inputs
- Cadence
cadence_nametextRequired - The cadence. Pick one, or give its name from an earlier step.
- From
start_datedateRequired - The first day to report on.
- Until
end_datedateRequired - The last day to report on.
Outputs
countnumber- How many steps
stepslist- The cadence's steps
Example output
{
"count": 1,
"steps": [
{
"linkCount": 3,
"mailCount": 20,
"negativeReply": 0,
"openCount": 12,
"openPercent": 60,
"positiveReply": 1,
"replyCount": 2,
"replyPercent": 10,
"stepNumber": 1,
"stepType": "Email",
"subject": "Hello",
"templateName": "Intro email"
}
]
}Get prospect
Get one prospect by email: name, company, list, tags and owner, and their custom fields if you ask for them.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
- Include custom fields
include_custom_fieldstrue/false - Also return the prospect's custom fields.Default:
false.
Outputs
prospectobject- The prospect
Example output
{
"prospect": {
"City": "Boston",
"Company": "Acme",
"Country": "United States",
"CustomFields": {
"gender": "female"
},
"Email": "jo@example.com",
"FirstName": "Jo",
"FullName": "Jo Bloggs",
"LastName": "Bloggs",
"LinkedinURL": "https://www.linkedin.com/in/jo-bloggs",
"List": "Leads",
"Phone": "+15555555555",
"Tags": "paid",
"Title": "Head of Sales",
"assignTo": "owner@example.com",
"id": "589c78690d66820b0005ced5"
}
}Get prospect status
Check where a prospect stands: their status and their cadence status, such as In Cadence.
Inputs
- Prospect email or ID
prospecttextRequired - The prospect's email address, or their Klenty id.
Outputs
cadence_statustext- The prospect's status in their cadence
prospect_statustext- The prospect's overall status
Example output
{
"cadence_status": "In Cadence",
"prospect_status": "In Cadence"
}List cadences
Get the company's cadences.
Inputs
None.
Outputs
cadenceslist- The cadences
countnumber- How many cadences
Example output
{
"cadences": [
{
"id": "5e9f2",
"name": "Intro"
}
],
"count": 1
}List calls
Get completed calls made from Klenty between two days, which must be within the last 30 days. 200 calls a page.
Inputs
- From
start_datedateRequired - The first day to include (within the last 30 days).
- Until
end_datedateRequired - The last day to include (within the last 30 days).
- Page
pagenumber - Which page to get, starting at 0.At least 0.
Outputs
callslist- The calls
countnumber- How many calls are on this page
has_moretrue/false- True if another page may follow
next_pagenumber- The page to ask for next, 0 if there is none
Example output
{
"calls": [
{
"callSid": "CA123",
"company": "Acme",
"disposition": "Connected",
"duration": 120,
"email": "jo@example.com",
"endTime": "2026-10-20T14:02:00Z",
"fullName": "Jo Bloggs",
"notes": "Asked for a demo",
"outcome": "Interested",
"startTime": "2026-10-20T14:00:00Z",
"status": "completed",
"username": "owner@example.com"
}
],
"count": 1,
"has_more": false,
"next_page": 0
}List lists
Get the account's prospect lists.
Inputs
None.
Outputs
countnumber- How many lists
listslist- The lists
Example output
{
"count": 1,
"lists": [
{
"id": "5e9f1",
"name": "Leads"
}
]
}List prospects changed between dates
Get the prospects that were changed in Klenty between two days.
Inputs
- From
start_datedateRequired - The first day to include.
- Until
end_datedate - The last day to include. Defaults to today.
Outputs
countnumber- How many prospects
prospectslist- The prospects
Example output
{
"count": 1,
"prospects": [
{
"City": "Boston",
"Company": "Acme",
"Country": "United States",
"CustomFields": {
"gender": "female"
},
"Email": "jo@example.com",
"FirstName": "Jo",
"FullName": "Jo Bloggs",
"LastName": "Bloggs",
"LinkedinURL": "https://www.linkedin.com/in/jo-bloggs",
"List": "Leads",
"Phone": "+15555555555",
"Tags": "paid",
"Title": "Head of Sales",
"assignTo": "owner@example.com",
"id": "589c78690d66820b0005ced5"
}
]
}List prospects created between dates
Get the prospects added to Klenty between two days.
Inputs
- From
start_datedateRequired - The first day to include.
- Until
end_datedate - The last day to include. Defaults to today.
Outputs
countnumber- How many prospects
prospectslist- The prospects
Example output
{
"count": 1,
"prospects": [
{
"City": "Boston",
"Company": "Acme",
"Country": "United States",
"CustomFields": {
"gender": "female"
},
"Email": "jo@example.com",
"FirstName": "Jo",
"FullName": "Jo Bloggs",
"LastName": "Bloggs",
"LinkedinURL": "https://www.linkedin.com/in/jo-bloggs",
"List": "Leads",
"Phone": "+15555555555",
"Tags": "paid",
"Title": "Head of Sales",
"assignTo": "owner@example.com",
"id": "589c78690d66820b0005ced5"
}
]
}List prospects in a list
Get the prospects in one list, a page at a time (up to 1000 a page). To see more, run it again with the next page it gives.
Inputs
- List
list_nametextRequired - The list. Pick one, or give its name from an earlier step.
- Page
pagenumber - Which page to get, starting at 1.At least 1.
- Page size
limitnumber - How many prospects a page, 1 to 1000. Defaults to 100.From 1 to 1000.
Outputs
countnumber- How many prospects are on this page
has_moretrue/false- True if another page may follow
next_pagenumber- The page to ask for next, 0 if there is none
prospectslist- The prospects
Example output
{
"count": 1,
"has_more": false,
"next_page": 0,
"prospects": [
{
"City": "Boston",
"Company": "Acme",
"Country": "United States",
"CustomFields": {
"gender": "female"
},
"Email": "jo@example.com",
"FirstName": "Jo",
"FullName": "Jo Bloggs",
"LastName": "Bloggs",
"LinkedinURL": "https://www.linkedin.com/in/jo-bloggs",
"List": "Leads",
"Phone": "+15555555555",
"Tags": "paid",
"Title": "Head of Sales",
"assignTo": "owner@example.com",
"id": "589c78690d66820b0005ced5"
}
]
}List webhooks
Get the account's webhooks with their events and addresses.
Inputs
None.
Outputs
countnumber- How many webhooks
webhookslist- The webhooks
Example output
{
"count": 1,
"webhooks": [
{
"event": "reply",
"id": "5e9f360ec0d425001292903b",
"url": "https://example.com/klenty"
}
]
}Mark prospect Do Not Contact
Stop all future emails to a prospect by marking them Do Not Contact. 'Revert Do Not Contact' undoes it.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
Outputs
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"email": "jo@example.com",
"success": true
}Remove tags from prospect
Take one or more tags off a prospect.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
- Tags
tagslistRequired - The tags to remove, one per row.
Outputs
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"email": "jo@example.com",
"success": true
}Resume cadence
Resume a prospect's paused cadence.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
Outputs
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"email": "jo@example.com",
"success": true
}Revert Do Not Contact
Take a prospect off Do Not Contact. They go back to Not Contacted, or to Manually Stopped if they had been contacted.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
Outputs
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"email": "jo@example.com",
"success": true
}Start cadence
Start a cadence for a prospect who is already in Klenty.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
- Cadence
cadence_nametextRequired - The cadence. Pick one, or give its name from an earlier step.
Outputs
cadence_nametext- The cadence started
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"cadence_name": "Intro",
"email": "jo@example.com",
"success": true
}Stop cadence
Take a prospect out of a cadence. Leave the cadence empty to take them out of every cadence they are in.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
- Cadence
cadence_nametext - The cadence to stop. Leave empty to stop all of them.
Outputs
cadence_nametext- The cadence stopped, empty if all of them
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"cadence_name": "Intro",
"email": "jo@example.com",
"success": true
}Stop prospect's emails
Stop the emails scheduled for a prospect.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
Outputs
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"email": "jo@example.com",
"success": true
}Update prospect
Change a prospect's details, list, tags, custom fields or outcome. Fields left empty stay as they are.
Inputs
- Prospect email
prospect_emailtextRequired - The prospect's email address.
- First name
first_nametext - The prospect's first name.
- Last name
last_nametext - The prospect's last name.
- Company
companytext - The company they work for.
- Job title
titletext - Their job title.
- Phone
phonetext - Their phone number.
- Department
departmenttext - Their department.
- Company website
company_domaintext - The company's domain.
- LinkedIn URL
linkedin_urltext - The link to their LinkedIn profile.
- City
citytext - Their city.
- Country
countrytext - Their country.
- Location
locationtext - Their location as one line.
- List
list_nametext - The list to put the prospect in.
- Tags
tagslist - Tags to set on the prospect, one per row.
- Custom fields
custom_fieldsobject - Your own Klenty fields: each field's name with its value.
- Outcome
outcometext - The prospect's outcome, spelled exactly as in Klenty (for example Lost).
Outputs
emailtext- The prospect's email address
successtrue/false- True once Klenty has done it
Example output
{
"email": "jo@example.com",
"success": true
}Update webhook
Change the event and address of a webhook.
Inputs
- Webhook
webhook_idtextRequired - The webhook. Pick one, or give its id from an earlier step.
- Event
eventtextRequired - What makes Klenty send a notification.One of:
reply(A prospect replies),cadenceFirstReply(A prospect replies for the first time in a cadence),sendProspect(A prospect is sent to another app),startCadence(A prospect starts a cadence),completeCadence(A prospect completes a cadence),onMailBounce(An email bounces),open(An email is opened),click(A link is clicked),unsubscribe(A prospect unsubscribes). - Address
urltextRequired - The https:// address Klenty sends notifications to.
Outputs
eventtext- Its event now
successtrue/false- True once Klenty has done it
urltext- Its address now
webhook_idtext- The webhook changed
Example output
{
"event": "open",
"success": true,
"url": "https://example.com/klenty",
"webhook_id": "5e9f360ec0d425001292903b"
}