Kommo
App · 29 actions
Run your Kommo sales CRM from workflows: create and move leads between pipeline stages, keep contacts and companies, add tasks and notes, tag and link records.
Actions
| Action | What it does |
|---|---|
| Complete task | Mark a task as done, with a line on how it went. |
| Create company | Create a company with a name, phone and email. |
| Create contact | Create a contact with a name, phone and email. |
| Create lead | Create a lead in a pipeline stage, optionally linked to a contact and company. |
| Create note | Add a text note to a lead, contact or company. |
| Create tag | Create a tag for leads, contacts or companies. |
| Create task | Create a task with a deadline, optionally on a lead, contact or company. |
| Get account | Get the connected Kommo account: its name, currency and country, and the task types it offers. |
| Get company | Get one company with its linked leads and contacts. |
| Get contact | Get one contact with the leads it is linked to. |
| Get lead | Get one lead with its tags, linked contacts and loss reason. |
| Get task | Get one task with its deadline, owner and result. |
| Link records | Link a lead, contact or company to another, for example a contact to a lead. |
| List companies | List or search companies by name or other field text. |
| List contacts | List or search contacts by name, phone, email or other field text. |
| List leads | List leads, filtered by search text, pipeline, stage, owner or dates. |
| List links | List the leads, contacts and companies a record is linked to. |
| List loss reasons | List the reasons a lead can be closed as lost. |
| List notes | List the notes on one lead, contact or company, or on every record of that kind when no id is given. |
| List pipelines | List the account's lead pipelines, each with its stages and their ids. |
| List tags | List the tags used on leads, contacts or companies. |
| List tasks | List tasks, filtered by open or completed, type, owner or the record they are on. |
| List users | List the account's users with their ids, names and emails. |
| Unlink records | Remove the link between two records. |
| Update company | Change a company's name, phone, email, owner, tags or custom fields. |
| Update contact | Change a contact's name, phone, email, owner, tags or custom fields. |
| Update lead | Change a lead: rename it, change the amount or owner, move it to another stage (including closed won or lost), tag it. |
| Update note | Change the text of a text note. |
| Update task | Change a task's wording, deadline, type or owner. |
Complete task
Mark a task as done, with a line on how it went.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
- Result
result_texttext - A line on how it went, kept on the task.
Outputs
taskobject- The task
Example output
{
"task": {
"account_id": 0,
"complete_till": 0,
"created_at": 0,
"created_by": 0,
"duration": 0,
"entity_id": 0,
"entity_type": "",
"group_id": 0,
"id": 5698123,
"is_completed": false,
"request_id": "",
"responsible_user_id": 0,
"result": {
"text": ""
},
"task_type_id": 0,
"text": "",
"updated_at": 1790000300,
"updated_by": 0
}
}Create company
Create a company with a name, phone and email. The result holds the new company's id.
Inputs
- Name
nametextRequired - The company's name.
- Phone
phonetext - A work phone number, like +15555550123. Replaces the phone numbers it has.
- Email
emailtext - A work email address. Replaces the email addresses it has.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Tags
tagslist - Tags to put on the company. New names are created.
- Custom fields
custom_fieldsobject - Other fields to set, each custom field's name as shown in Kommo (or its id) with the value. Dates take a Unix timestamp or an RFC 3339 text, checkboxes true or false, and lists the option's text.
Outputs
companyobject- The company
Example output
{
"company": {
"_embedded": {
"contacts": [],
"leads": [],
"tags": []
},
"account_id": 0,
"closest_task_at": 0,
"created_at": 0,
"created_by": 0,
"custom_fields_values": [],
"group_id": 0,
"id": 7345678,
"is_deleted": false,
"name": "",
"request_id": "0",
"responsible_user_id": 0,
"updated_at": 0,
"updated_by": 0
}
}Create contact
Create a contact with a name, phone and email. The result holds the new contact's id.
Inputs
- First name
first_nametextRequired - The contact's first name.
- Last name
last_nametext - The contact's last name.
- Phone
phonetext - A work phone number, like +15555550123. Replaces the phone numbers it has.
- Email
emailtext - A work email address. Replaces the email addresses it has.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Tags
tagslist - Tags to put on the contact. New names are created.
- Custom fields
custom_fieldsobject - Other fields to set, each custom field's name as shown in Kommo (or its id) with the value. Dates take a Unix timestamp or an RFC 3339 text, checkboxes true or false, and lists the option's text.
Outputs
contactobject- The contact
Example output
{
"contact": {
"_embedded": {
"companies": [],
"leads": [],
"tags": []
},
"account_id": 0,
"closest_task_at": 0,
"created_at": 0,
"created_by": 0,
"custom_fields_values": [],
"first_name": "",
"group_id": 0,
"id": 9234567,
"is_deleted": false,
"last_name": "",
"name": "",
"request_id": "0",
"responsible_user_id": 0,
"updated_at": 0,
"updated_by": 0
}
}Create lead
Create a lead in a pipeline stage, optionally linked to a contact and company. Without a pipeline it goes in the main pipeline's first stage. The result holds the new lead's id.
Inputs
- Name
nametextRequired - The lead's name.
- Sale amount
pricenumber - The lead's sale amount, a whole number in the account's currency.At least 0.
- Pipeline
pipeline_idtext - The sales pipeline. Pick one, or give a pipeline id.
- Stage
status_idtext - The stage in that pipeline. Pick the pipeline first. Closed stages are listed too.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Contact ID
contact_idtext - A contact to link as the main contact, from 'Create contact' or 'List contacts'.
- Company ID
company_idtext - A company to link, from 'Create company' or 'List companies'.
- Tags
tagslist - Tags to put on the lead. New names are created.
- Custom fields
custom_fieldsobject - Other fields to set, each custom field's name as shown in Kommo (or its id) with the value. Dates take a Unix timestamp or an RFC 3339 text, checkboxes true or false, and lists the option's text.
Outputs
leadobject- The lead
Example output
{
"lead": {
"_embedded": {
"companies": [],
"contacts": [],
"loss_reason": [],
"tags": []
},
"account_id": 0,
"closed_at": 0,
"closest_task_at": 0,
"created_at": 0,
"created_by": 0,
"custom_fields_values": [],
"group_id": 0,
"id": 8123456,
"is_deleted": false,
"loss_reason_id": 0,
"name": "",
"pipeline_id": 0,
"price": 0,
"request_id": "0",
"responsible_user_id": 0,
"score": 0,
"status_id": 0,
"updated_at": 0,
"updated_by": 0
}
}Create note
Add a text note to a lead, contact or company. The result holds the new note's id.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Record ID
entity_idtextRequired - The lead, contact or company to add the note to.
- Note
texttextRequired - The note's text.
Outputs
noteobject- The note
Example output
{
"note": {
"account_id": 0,
"created_at": 0,
"created_by": 0,
"entity_id": 8123456,
"id": 4276610,
"note_type": "",
"params": {
"text": ""
},
"request_id": "0",
"responsible_user_id": 0,
"updated_at": 0,
"updated_by": 0
}
}Create tag
Create a tag for leads, contacts or companies.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Name
nametextRequired - The tag's name.
Outputs
tagobject- The tag
Example output
{
"tag": {
"color": "",
"id": 263807,
"name": "VIP",
"request_id": "0"
}
}Create task
Create a task with a deadline, optionally on a lead, contact or company. The result holds the new task's id.
Inputs
- Task
texttextRequired - What needs doing.
- Deadline
complete_tilldate and timeRequired - When the task is due.
- Task type
task_type_idtext - The kind of task, such as Follow-up or Meeting. Defaults to Follow-up.
- Owner
responsible_user_idtext - Who does the task. Defaults to the user who made the token.
- On record type
entity_typetext - Put the task on a lead, a contact or a company. Give the record's id too.One of:
leads(Lead),contacts(Contact),companies(Company). - Record ID
entity_idtext - The lead, contact or company the task is on. Pick the record type too.
Outputs
taskobject- The task
Example output
{
"task": {
"account_id": 0,
"complete_till": 0,
"created_at": 0,
"created_by": 0,
"duration": 0,
"entity_id": 0,
"entity_type": "",
"group_id": 0,
"id": 5698123,
"is_completed": false,
"request_id": "0",
"responsible_user_id": 0,
"result": {
"text": ""
},
"task_type_id": 0,
"text": "",
"updated_at": 0,
"updated_by": 0
}
}Get account
Get the connected Kommo account: its name, currency and country, and the task types it offers.
Inputs
None.
Outputs
accountobject- The Kommo account
task_typeslist- The task types the account has
Example output
{
"account": {
"country": "US",
"created_at": 1700000000,
"created_by": 504141,
"currency": "USD",
"currency_symbol": "$",
"current_user_id": 504141,
"id": 31361463,
"is_loss_reason_enabled": true,
"is_unsorted_on": true,
"language": "en",
"name": "Acme",
"subdomain": "acme",
"updated_at": 1790000000,
"updated_by": 504141
},
"task_types": [
{
"code": "FOLLOW_UP",
"id": 1,
"name": "Follow-up"
},
{
"code": "MEETING",
"id": 2,
"name": "Meeting"
}
]
}Get company
Get one company with its linked leads and contacts.
Inputs
- Company ID
company_idtextRequired - The company's id, from 'List companies' or an earlier step.
Outputs
companyobject- The company
Example output
{
"company": {
"_embedded": {
"contacts": [],
"leads": [],
"tags": []
},
"account_id": 31361463,
"closest_task_at": 0,
"created_at": 1790000000,
"created_by": 504141,
"custom_fields_values": [],
"group_id": 0,
"id": 7345678,
"is_deleted": false,
"name": "Acme Co.",
"request_id": "",
"responsible_user_id": 504141,
"updated_at": 1790000300,
"updated_by": 504141
}
}Get contact
Get one contact with the leads it is linked to.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'List contacts' or an earlier step.
Outputs
contactobject- The contact
Example output
{
"contact": {
"_embedded": {
"companies": [],
"leads": [
{
"id": 8123456
}
],
"tags": []
},
"account_id": 31361463,
"closest_task_at": 0,
"created_at": 1790000000,
"created_by": 504141,
"custom_fields_values": [
{
"field_code": "PHONE",
"field_id": 3,
"field_name": "Phone",
"field_type": "multitext",
"values": [
{
"enum_code": "WORK",
"enum_id": 1,
"value": "+15555550123"
}
]
}
],
"first_name": "Jo",
"group_id": 0,
"id": 9234567,
"is_deleted": false,
"last_name": "Bloggs",
"name": "Jo Bloggs",
"request_id": "",
"responsible_user_id": 504141,
"updated_at": 1790000300,
"updated_by": 504141
}
}Get lead
Get one lead with its tags, linked contacts and loss reason.
Inputs
- Lead ID
lead_idtextRequired - The lead's id, from 'List leads' or an earlier step.
Outputs
leadobject- The lead
Example output
{
"lead": {
"_embedded": {
"companies": [],
"contacts": [
{
"id": 9234567,
"is_main": true
}
],
"loss_reason": [],
"tags": [
{
"color": "",
"id": 263807,
"name": "Website"
}
]
},
"account_id": 31361463,
"closed_at": 0,
"closest_task_at": 0,
"created_at": 1790000000,
"created_by": 504141,
"custom_fields_values": [],
"group_id": 0,
"id": 8123456,
"is_deleted": false,
"loss_reason_id": 0,
"name": "Website enquiry from Acme",
"pipeline_id": 6950551,
"price": 5000,
"request_id": "",
"responsible_user_id": 504141,
"score": 0,
"status_id": 58141807,
"updated_at": 1790000300,
"updated_by": 504141
}
}Get task
Get one task with its deadline, owner and result.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
Outputs
taskobject- The task
Example output
{
"task": {
"account_id": 31361463,
"complete_till": 1790086400,
"created_at": 1790000000,
"created_by": 504141,
"duration": 0,
"entity_id": 8123456,
"entity_type": "leads",
"group_id": 0,
"id": 5698123,
"is_completed": false,
"request_id": "",
"responsible_user_id": 504141,
"result": {
"text": ""
},
"task_type_id": 1,
"text": "Call to confirm the quote",
"updated_at": 1790000300,
"updated_by": 504141
}
}Link records
Link a lead, contact or company to another, for example a contact to a lead.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Record ID
entity_idtextRequired - The record to link from.
- Other record type
to_entity_typetextRequired - The kind of record to link with.One of:
leads(Lead),contacts(Contact),companies(Company). - Other record ID
to_entity_idtextRequired - The record to link to.
- Main contact
is_maintrue/false - When linking a contact, make it the main one.
Outputs
countnumber- How many links
linkslist- The links
Example output
{
"count": 1,
"links": [
{
"entity_id": 8123456,
"entity_type": "leads",
"metadata": {
"catalog_id": 0,
"is_main": false,
"main_contact": true,
"quantity": 0
},
"to_entity_id": 9234567,
"to_entity_type": "contacts"
}
]
}List companies
List or search companies by name or other field text. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Search
querytext - Only companies with this text in their name, phone, email or other fields.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Created on or after
created_fromdate - Only companies created on or after this date.
- Created on or before
created_todate - Only companies created on or before this date.
- Updated on or after
updated_fromdate - Only companies changed on or after this date.
- Updated on or before
updated_todate - Only companies changed on or before this date.
- Sort by
order_bytext - What to sort by. Leave empty for Kommo's own order.One of:
updated_at(Date updated),id. - Order
directiontext - Ascending is oldest or lowest first. Defaults to ascending.One of:
asc(Oldest or lowest first),desc(Newest or highest first). - Page
pagenumber - Which page to return, starting at 1. Defaults to the first.At least 1.
- Page size
limitnumber - How many to return, 1 to 250. Kommo's default is 50.From 1 to 250.
Outputs
companieslist- The companies
countnumber- How many on this page
next_pagenumber- Pass as 'page' for the next page; 0 on the last one
pagenumber- The page number of this page
Example output
{
"companies": [
{
"_embedded": {
"contacts": [],
"leads": [],
"tags": []
},
"account_id": 31361463,
"closest_task_at": 0,
"created_at": 1790000000,
"created_by": 504141,
"custom_fields_values": [],
"group_id": 0,
"id": 7345678,
"is_deleted": false,
"name": "Acme Co.",
"request_id": "",
"responsible_user_id": 504141,
"updated_at": 1790000300,
"updated_by": 504141
}
],
"count": 1,
"next_page": 0,
"page": 1
}List contacts
List or search contacts by name, phone, email or other field text. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Search
querytext - Only contacts with this text in their name, phone, email or other fields.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Updated on or after
updated_fromdate - Only contacts changed on or after this date.
- Updated on or before
updated_todate - Only contacts changed on or before this date.
- Sort by
order_bytext - What to sort by. Leave empty for Kommo's own order.One of:
updated_at(Date updated),id. - Order
directiontext - Ascending is oldest or lowest first. Defaults to ascending.One of:
asc(Oldest or lowest first),desc(Newest or highest first). - Page
pagenumber - Which page to return, starting at 1. Defaults to the first.At least 1.
- Page size
limitnumber - How many to return, 1 to 250. Kommo's default is 50.From 1 to 250.
Outputs
contactslist- The contacts
countnumber- How many on this page
next_pagenumber- Pass as 'page' for the next page; 0 on the last one
pagenumber- The page number of this page
Example output
{
"contacts": [
{
"_embedded": {
"companies": [],
"leads": [
{
"id": 8123456
}
],
"tags": []
},
"account_id": 31361463,
"closest_task_at": 0,
"created_at": 1790000000,
"created_by": 504141,
"custom_fields_values": [
{
"field_code": "PHONE",
"field_id": 3,
"field_name": "Phone",
"field_type": "multitext",
"values": [
{
"enum_code": "WORK",
"enum_id": 1,
"value": "+15555550123"
}
]
}
],
"first_name": "Jo",
"group_id": 0,
"id": 9234567,
"is_deleted": false,
"last_name": "Bloggs",
"name": "Jo Bloggs",
"request_id": "",
"responsible_user_id": 504141,
"updated_at": 1790000300,
"updated_by": 504141
}
],
"count": 1,
"next_page": 0,
"page": 1
}List leads
List leads, filtered by search text, pipeline, stage, owner or dates. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Search
querytext - Only leads with this text in their name or fields.
- Pipeline
pipeline_idtext - The sales pipeline. Pick one, or give a pipeline id.
- Stage
status_idtext - The stage in that pipeline. Pick the pipeline first. Closed stages are listed too.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Created on or after
created_fromdate - Only leads created on or after this date.
- Created on or before
created_todate - Only leads created on or before this date.
- Updated on or after
updated_fromdate - Only leads changed on or after this date.
- Updated on or before
updated_todate - Only leads changed on or before this date.
- Sort by
order_bytext - What to sort by. Leave empty for Kommo's own order.One of:
created_at(Date created),updated_at(Date updated),id. - Order
directiontext - Ascending is oldest or lowest first. Defaults to ascending.One of:
asc(Oldest or lowest first),desc(Newest or highest first). - Include linked contacts
include_contactstrue/false - Also return the ids of the contacts linked to each lead.Default:
false. - Page
pagenumber - Which page to return, starting at 1. Defaults to the first.At least 1.
- Page size
limitnumber - How many to return, 1 to 250. Kommo's default is 50.From 1 to 250.
Outputs
countnumber- How many on this page
leadslist- The leads
next_pagenumber- Pass as 'page' for the next page; 0 on the last one
pagenumber- The page number of this page
Example output
{
"count": 1,
"leads": [
{
"_embedded": {
"companies": [],
"contacts": [
{
"id": 9234567,
"is_main": true
}
],
"loss_reason": [],
"tags": [
{
"color": "",
"id": 263807,
"name": "Website"
}
]
},
"account_id": 31361463,
"closed_at": 0,
"closest_task_at": 0,
"created_at": 1790000000,
"created_by": 504141,
"custom_fields_values": [],
"group_id": 0,
"id": 8123456,
"is_deleted": false,
"loss_reason_id": 0,
"name": "Website enquiry from Acme",
"pipeline_id": 6950551,
"price": 5000,
"request_id": "",
"responsible_user_id": 504141,
"score": 0,
"status_id": 58141807,
"updated_at": 1790000300,
"updated_by": 504141
}
],
"next_page": 0,
"page": 1
}List links
List the leads, contacts and companies a record is linked to.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Record ID
entity_idtextRequired - The lead, contact or company to read the links of.
Outputs
countnumber- How many links
linkslist- The links
Example output
{
"count": 1,
"links": [
{
"entity_id": 8123456,
"entity_type": "leads",
"metadata": {
"catalog_id": 0,
"is_main": false,
"main_contact": true,
"quantity": 0
},
"to_entity_id": 9234567,
"to_entity_type": "contacts"
}
]
}List loss reasons
List the reasons a lead can be closed as lost.
Inputs
None.
Outputs
countnumber- How many reasons
loss_reasonslist- The loss reasons
Example output
{
"count": 1,
"loss_reasons": [
{
"id": 21403207,
"name": "Insufficient budget",
"sort": 0
}
]
}List notes
List the notes on one lead, contact or company, or on every record of that kind when no id is given. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Record ID
entity_idtext - Only notes on this record. Leave empty for every record of the type.
- Page
pagenumber - Which page to return, starting at 1. Defaults to the first.At least 1.
- Page size
limitnumber - How many to return, 1 to 250. Kommo's default is 50.From 1 to 250.
Outputs
countnumber- How many on this page
next_pagenumber- Pass as 'page' for the next page; 0 on the last one
noteslist- The notes
pagenumber- The page number of this page
Example output
{
"count": 1,
"next_page": 0,
"notes": [
{
"account_id": 31361463,
"created_at": 1790000000,
"created_by": 504141,
"entity_id": 8123456,
"id": 4276610,
"note_type": "common",
"params": {
"text": "Spoke to the buyer"
},
"request_id": "",
"responsible_user_id": 504141,
"updated_at": 1790000300,
"updated_by": 504141
}
],
"page": 1
}List pipelines
List the account's lead pipelines, each with its stages and their ids.
Inputs
None.
Outputs
countnumber- How many pipelines
pipelineslist- The pipelines with their stages
Example output
{
"count": 1,
"pipelines": [
{
"account_id": 31361463,
"id": 6950551,
"is_archive": false,
"is_main": true,
"is_unsorted_on": true,
"name": "Sales pipeline",
"sort": 1,
"statuses": [
{
"color": "#99ccff",
"id": 58141807,
"is_editable": true,
"name": "Initial contact",
"pipeline_id": 6950551,
"sort": 20,
"type": 0
}
]
}
]
}List tags
List the tags used on leads, contacts or companies. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Search
querytext - Only tags with this text in their name.
- Page
pagenumber - Which page to return, starting at 1. Defaults to the first.At least 1.
- Page size
limitnumber - How many to return, 1 to 250. Kommo's default is 50.From 1 to 250.
Outputs
countnumber- How many on this page
next_pagenumber- Pass as 'page' for the next page; 0 on the last one
pagenumber- The page number of this page
tagslist- The tags
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"tags": [
{
"color": "",
"id": 263807,
"name": "Website",
"request_id": ""
}
]
}List tasks
List tasks, filtered by open or completed, type, owner or the record they are on. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Open or completed
statetext - Only open tasks, or only completed ones. Leave empty for both.One of:
open(Open tasks),completed(Completed tasks). - Task type
task_type_idtext - The kind of task, such as Follow-up or Meeting.
- Owner
responsible_user_idtext - Only tasks for this Kommo user. Pick one, or give a user id.
- On record type
entity_typetext - Only tasks on this kind of record. Give the record's id too.One of:
leads(Lead),contacts(Contact),companies(Company). - Record ID
entity_idtext - Only tasks on this record. Pick the record type too.
- Sort by
order_bytext - What to sort by. Leave empty for Kommo's own order.One of:
complete_till(Deadline),created_at(Date created),id. - Order
directiontext - Ascending is oldest or lowest first. Defaults to ascending.One of:
asc(Oldest or lowest first),desc(Newest or highest first). - Page
pagenumber - Which page to return, starting at 1. Defaults to the first.At least 1.
- Page size
limitnumber - How many to return, 1 to 250. Kommo's default is 50.From 1 to 250.
Outputs
countnumber- How many on this page
next_pagenumber- Pass as 'page' for the next page; 0 on the last one
pagenumber- The page number of this page
taskslist- The tasks
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"tasks": [
{
"account_id": 31361463,
"complete_till": 1790086400,
"created_at": 1790000000,
"created_by": 504141,
"duration": 0,
"entity_id": 8123456,
"entity_type": "leads",
"group_id": 0,
"id": 5698123,
"is_completed": false,
"request_id": "",
"responsible_user_id": 504141,
"result": {
"text": ""
},
"task_type_id": 1,
"text": "Call to confirm the quote",
"updated_at": 1790000300,
"updated_by": 504141
}
]
}List users
List the account's users with their ids, names and emails. Needs a token made by an administrator.
Inputs
- Page
pagenumber - Which page to return, starting at 1. Defaults to the first.At least 1.
- Page size
limitnumber - How many to return, 1 to 250. Kommo's default is 50.From 1 to 250.
Outputs
countnumber- How many on this page
next_pagenumber- Pass as 'page' for the next page; 0 on the last one
pagenumber- The page number of this page
userslist- The users
Example output
{
"count": 1,
"next_page": 0,
"page": 1,
"users": [
{
"email": "jo@example.com",
"id": 504141,
"lang": "en",
"name": "Jo Bloggs"
}
]
}Unlink records
Remove the link between two records. Neither record is deleted.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Record ID
entity_idtextRequired - The record to unlink from.
- Other record type
to_entity_typetextRequired - The kind of record to link with.One of:
leads(Lead),contacts(Contact),companies(Company). - Other record ID
to_entity_idtextRequired - The record to unlink.
Outputs
entity_idnumber- The id of the first record
entity_typetext- The type of the first record
to_entity_idnumber- The id of the other record
to_entity_typetext- The type of the other record
unlinkedtrue/false- Always true once unlinked
Example output
{
"entity_id": 8123456,
"entity_type": "leads",
"to_entity_id": 9234567,
"to_entity_type": "contacts",
"unlinked": true
}Update company
Change a company's name, phone, email, owner, tags or custom fields. Fields left empty stay as they are.
Inputs
- Company ID
company_idtextRequired - The company's id, from 'List companies' or an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Phone
phonetext - A work phone number, like +15555550123. Replaces the phone numbers it has.
- Email
emailtext - A work email address. Replaces the email addresses it has.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Add tags
add_tagslist - Tags to put on the company. New names are created.
- Remove tags
remove_tagslist - Tags to take off the company.
- Custom fields
custom_fieldsobject - Other fields to set, each custom field's name as shown in Kommo (or its id) with the value. Dates take a Unix timestamp or an RFC 3339 text, checkboxes true or false, and lists the option's text.
Outputs
companyobject- The company
Example output
{
"company": {
"_embedded": {
"contacts": [],
"leads": [],
"tags": []
},
"account_id": 0,
"closest_task_at": 0,
"created_at": 0,
"created_by": 0,
"custom_fields_values": [],
"group_id": 0,
"id": 7345678,
"is_deleted": false,
"name": "",
"request_id": "",
"responsible_user_id": 0,
"updated_at": 1790000300,
"updated_by": 0
}
}Update contact
Change a contact's name, phone, email, owner, tags or custom fields. Fields left empty stay as they are.
Inputs
- Contact ID
contact_idtextRequired - The contact's id, from 'List contacts' or an earlier step.
- First name
first_nametext - A new first name. Leave empty to keep it.
- Last name
last_nametext - A new last name. Leave empty to keep it.
- Phone
phonetext - A work phone number, like +15555550123. Replaces the phone numbers it has.
- Email
emailtext - A work email address. Replaces the email addresses it has.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Add tags
add_tagslist - Tags to put on the contact. New names are created.
- Remove tags
remove_tagslist - Tags to take off the contact.
- Custom fields
custom_fieldsobject - Other fields to set, each custom field's name as shown in Kommo (or its id) with the value. Dates take a Unix timestamp or an RFC 3339 text, checkboxes true or false, and lists the option's text.
Outputs
contactobject- The contact
Example output
{
"contact": {
"_embedded": {
"companies": [],
"leads": [],
"tags": []
},
"account_id": 0,
"closest_task_at": 0,
"created_at": 0,
"created_by": 0,
"custom_fields_values": [],
"first_name": "",
"group_id": 0,
"id": 9234567,
"is_deleted": false,
"last_name": "",
"name": "",
"request_id": "",
"responsible_user_id": 0,
"updated_at": 1790000300,
"updated_by": 0
}
}Update lead
Change a lead: rename it, change the amount or owner, move it to another stage (including closed won or lost), tag it. Fields left empty stay as they are.
Inputs
- Lead ID
lead_idtextRequired - The lead's id, from 'List leads' or an earlier step.
- Name
nametext - A new name. Leave empty to keep it.
- Sale amount
pricenumber - A new sale amount, 0 or more. Leave empty to keep it.At least 0.
- Pipeline
pipeline_idtext - The sales pipeline. Pick one, or give a pipeline id.
- Stage
status_idtext - The stage in that pipeline. Pick the pipeline first. Closed stages are listed too.
- Owner
responsible_user_idtext - The Kommo user responsible for it. Pick one, or give a user id.
- Loss reason
loss_reason_idtext - Why the lead was lost, when moving it to the closed-lost stage.
- Add tags
add_tagslist - Tags to put on the lead. New names are created.
- Remove tags
remove_tagslist - Tags to take off the lead.
- Custom fields
custom_fieldsobject - Other fields to set, each custom field's name as shown in Kommo (or its id) with the value. Dates take a Unix timestamp or an RFC 3339 text, checkboxes true or false, and lists the option's text.
Outputs
leadobject- The lead
Example output
{
"lead": {
"_embedded": {
"companies": [],
"contacts": [],
"loss_reason": [],
"tags": []
},
"account_id": 0,
"closed_at": 0,
"closest_task_at": 0,
"created_at": 0,
"created_by": 0,
"custom_fields_values": [],
"group_id": 0,
"id": 8123456,
"is_deleted": false,
"loss_reason_id": 0,
"name": "",
"pipeline_id": 0,
"price": 0,
"request_id": "",
"responsible_user_id": 0,
"score": 0,
"status_id": 0,
"updated_at": 1790000300,
"updated_by": 0
}
}Update note
Change the text of a text note.
Inputs
- Record type
entity_typetextRequired - Whether it is on a lead, a contact or a company.One of:
leads(Lead),contacts(Contact),companies(Company). - Note ID
note_idtextRequired - The note's id, from 'List notes' or 'Create note'.
- Note
texttextRequired - The note's text.
Outputs
noteobject- The note
Example output
{
"note": {
"account_id": 0,
"created_at": 0,
"created_by": 0,
"entity_id": 8123456,
"id": 4276610,
"note_type": "",
"params": {
"text": ""
},
"request_id": "",
"responsible_user_id": 0,
"updated_at": 1790000300,
"updated_by": 0
}
}Update task
Change a task's wording, deadline, type or owner. Fields left empty stay as they are.
Inputs
- Task ID
task_idtextRequired - The task's id, from 'List tasks' or an earlier step.
- Task
texttext - New wording. Leave empty to keep it.
- Deadline
complete_tilldate and time - A new deadline. Leave empty to keep it.
- Task type
task_type_idtext - The kind of task, such as Follow-up or Meeting.
- Owner
responsible_user_idtext - A new owner. Leave empty to keep it.
Outputs
taskobject- The task
Example output
{
"task": {
"account_id": 0,
"complete_till": 0,
"created_at": 0,
"created_by": 0,
"duration": 0,
"entity_id": 0,
"entity_type": "",
"group_id": 0,
"id": 5698123,
"is_completed": false,
"request_id": "",
"responsible_user_id": 0,
"result": {
"text": ""
},
"task_type_id": 0,
"text": "",
"updated_at": 1790000300,
"updated_by": 0
}
}