Jump to Content
Documentation
Recipes
API Reference
Changelog
Discussions
🇧🇷
🇪🇸
Community in Discord
API Reference
🇧🇷
🇪🇸
Community in Discord
Documentation
Recipes
API Reference
Changelog
Discussions
Account
Search
All
Pages
Start typing to search…
JUMP TO
API V4 GENERAL METHODS
Account
Account parameters
get
OAuth 2.0
Get/renew an access token
post
Incoming leads
Incoming leads list
get
Getting an incoming lead by its UID
get
Adding incoming leads from the type sip (call)
post
Adding incoming leads from the type form
post
Accepting incoming leads
post
Declining incoming leads
delete
Linking incoming leads
post
Incoming leads summary information
get
Metadata objects description
Leads
Leads list
get
Getting a lead by its ID
get
Adding Leads
post
Updating Leads
patch
Updating a lead
patch
Complex addition of leads with contact and company
post
Leads pipelines and stages
Pipelines list
get
Getting a pipeline by its ID
get
Adding pipelines
post
Editing a pipeline
patch
Deleting a pipeline
delete
Pipeline stages list
get
Getting a pipeline stage data by its ID
get
Adding stages to the pipeline
post
Pipeline stage edit
patch
Deleting a pipeline stage
delete
Available stage colors
Contacts
Contacts List
get
Getting a contact by its ID
get
Adding contacts
post
Updating Contacts
patch
Updating a single contact
patch
Companies
Companies list
get
Getting a company by its ID
get
Add companies
post
Updating companies
patch
Updating a company
patch
Lists
Get a list of lists
get
Get a list
get
Adding lists
post
Editing lists
patch
Editing a list
patch
Get list elements
get
Get a list element
get
Adding list elements
post
Editing list elements
patch
Editing a list element
patch
Custom fields
Custom fields list
get
Custom fields list of a list
get
Getting an entity field by its ID
get
Getting a list field by its ID
get
Adding custom fields
post
Adding a custom field to a list
post
Updating custom fields
patch
Updating a custom field
patch
Updating custom fields of a list
patch
Updating a custom field of a list
patch
Deleting a custom field
delete
Users and roles
Users list
get
Getting user data by its ID
get
Adding users
post
User roles list
get
Getting a role data by its ID
get
Adding roles
post
Editing roles
patch
Deleting a role
delete
Tasks
Tasks List
get
Getting a task by its ID
get
Adding tasks
post
Editing tasks
patch
Editing a single task
patch
Events
Events list
get
Getting an event by its ID
get
Getting events types
get
Events types
Events filtration
Notes
Getting a particular entity’s notes list by the entity ID
get
Notes list by the entity type
get
Get a note by its ID
get
Adding notes
post
Editing notes
patch
Editing a note
patch
Notes types
Tags
List of entity tags
get
Creating tags for a particular entity type
post
Adding tags to entities
patch
Adding tags to a single entity
patch
Tag colors
Links between entities
Linked entities list
get
Linking entities
post
Unlinking entities
post
Salesbot
Launch Salesbot
post
SalesBot widget block execution confirmation
post
Sources
Get a list of sources
get
Get a source by its ID
get
Add sources
post
Update a source
patch
Update sources
patch
Delete a source
delete
Delete sources
delete
Get a list of Website chat button objects
get
Get a Website chat button
get
Add Website chat button
post
Connect online chat to Website chat button
post
Update Website chat button
patch
Templates
Get a list of templates
get
Get a template by ID
get
Add templates
post
Edit templates
patch
Submit a WhatsApp template for moderation
post
Edit a WhatsApp template status
post
Delete templates
delete
Delete a template
delete
Webhooks
List of webhooks
get
Adding a webhook
post
Deleting a webhook
delete
Webhook events
Widgets
Widgets List
get
Getting the widget info by its code
get
Installing the widget into the account
post
Uninstalling widget
delete
Conversations
Get a conversation by ID
get
Close a conversation by ID
post
Calls
Add calls
post
Files API
Files API capabilities
Files API Key Features
Files API methods
Getting started
Get a file by UUID
get
Get a list of files
get
Create a file upload session
post
Upload a part of the file
post
Edit a file
patch
Delete files
delete
Restore files
post
Get a version of file
get
Get files attached to an entity
get
Attach files to an entity
put
Detach files from an entity
delete
Get entities associated with a file
get
Chats API
Five steps to send a message
Step 1: Register a new channel
Step 2: Connect chat channel
post
Step 3: Create new chat
post
Step 4: Link chat to contact
post
Step 5: Send, receive, or import messages
post
Get chat history
get
Get contact chats
get
Update message delivery status
post
Transfer typing information
post
Send or withdraw reactions
post
Disconnect chat channel
delete
Chats API account ID
Chats API authorization
Receiving Chat webhooks
Kommo AI API
Kommo AI key features
Kommo AI API methods
Add a source of the type URL
post
Add a source of the type file
post
Add a source of the type text
post
Launch import of products from CRM to AI
post
Other docs
Documentation
Recipes
Powered byÂ
Ask AI
Account
In this section you can find the description of account properties.
