Document Server
Plugins and Macros
Document Builder
Desktop Editors
Community Server
Hosted Solution
Get Started
Basic concepts
Passing authentication
Usage API
authentication
Get the authentication token
Get the two-factor authentication token
Send sms code
Set a mobile phone
calendar
Calendars and subscriptions
Create a calendar
Create a calendar by iCal URL
Delete a calendar
Delete a project calendar
Get a calendar by ID
Get access parameters
Get CalDav link
Get calendars
Get default access parameters
Get iCal link
Get subscriptions
Get the iCal feed
Get the UTC offset
Update a calendar
Update the calendar view
Events
Add the iCal event
Create a new event in the default calendar
Create a new event in the selected calendar
Create a new iCal event
Delete an event from event series
Delete the CalDav event
Delete the event series
Get ics by ID
Get ics by UID
Import events from the iCal files
Import iCal events to the calendar
Import ics
Unsubscribe from the event
Update an event
Update the CalDav event
Update the iCal event
Tasks
Create a new task
Delete a task
Update a task
capabilities
Get portal capabilities
community
Birthday
Birthday subscription
Blogs
Add a blog comment
Add a post comment
Create a post
Delete a post
Get a comment preview
Get a post
Get my posts
Get post comments
Get posts
Get posts by tag
Get tags
Get user posts
Remove a comment
Search posts
Update a blog comment
Update a post
Bookmarks
Add a bookmark
Add a bookmark comment by bookmark ID
Add a bookmark comment by entity ID
Get a bookmark by a tag
Get a bookmark by ID
Get a comment preview
Get all tags
Get bookmark comments
Get bookmarks
Get my bookmarks
Get my favorite bookmarks
Get recent bookmarks
Get top of day bookmarks
Get top of month bookmarks
Get top of week bookmarks
Get top of year bookmarks
Remove a bookmark
Remove a bookmark from favorites
Remove a comment
Search bookmarks
Update a bookmark comment
Events
Add an event comment by entity ID
Add an event comment by feed ID
Comment subscription
Create an event
Delete an event
Get a comment preview
Get an event
Get events
Get my events
Get the event comments
Remove a comment
Search events
Update a comment
Update an event
Vote for an event
Forums
Add a post to a topic
Add a thread to a category
Add a topic to a thread
Delete a category
Delete a post
Delete a thread
Delete a topic
Get forums
Get last updated topics
Get thread topics
Get topic posts
Search topics
Update a topic
Update a topic post
Wiki
Add an entity comment
Create a page
Create a wiki comment
Delete a file
Delete a page
Get a comment preview
Get a file
Get a page
Get pages
Get the page comments
Get the page history
Remove a comment
Search pages by content
Search pages by name
Update a comment
Update a page
Upload files
Get preview
crm
Cases
Add a case contact
Close a case
Create a case
Delete a case
Delete a case contact
Delete cases by IDs
Delete cases by parameters
Get a case by ID
Get case contacts
Get cases
Resume a case
Set access rights to the case
Set access rights to the cases by IDs
Set access rights to the cases by parameters
Update a case
Common
Add currency rates
Convert a currency
Create a currency rate
Delete a currency rate
Get a currency rate by currencies
Get a currency rate by ID
Get all currency rates
Get available currencies
Get currency rates
Set currency rates
Set the tenant setting
Update a currency
Update a currency rate
Update web form key
Contacts
Add a contact opportunity
Add a person to the company
Add contact address information
Add contact information
Change a contact photo
Change a contact photo by URL
Create a company
Create a contact status
Create a contact type
Create a person
Create companies
Create persons
Delete a contact
Delete a contact avatar
Delete a contact opportunity
Delete a contact status
Delete a contact type
Delete a person from the company
Delete contact information
Delete contacts by IDs
Delete contacts by parameters
Get a contact by ID
Get a contact status
Get a contact type
Get all contact statuses
Get all contact types
Get contact access rights
Get contact categories by information type
Get contact information
Get contact information by ID
Get contact information by type
Get contact information types
Get contact social media images by contact ID
Get contact social media images by networks
Get contacts by contact information
Get contacts by project ID
Get filtered contacts
Get persons linked to the company
Get twitter profiles
Get user tweets
Link a contact to the project
Link contacts to the project
Merge contacts
Remove a contact from the project
Set access rights to the contact
Set access rights to the contacts by IDs
Set access rights to the contacts by parameters
Update a company
Update a contact status
Update a contact status by ID
Update a contact status color
Update a contact type
Update a person
Update a status of a company and its participants
Update a status of a person, related company and its participants
Update contact address information
Update contact information
Update the contact status setting
Update the order of contact statuses
Update the order of contact types
Update the setting for adding tags to the contact
Update the setting for writing mails to the history
Upload an avatar from social network
Custom fields
Create a custom field
Delete a custom field
Get custom fields
Get entity custom fields
Set an entity custom field
Update a custom field
Update the custom field order
Files
Attach files to the entity
Create a text file
Delete a file
Get entity files
Get root folder ID
Upload a file
History
Create a history category
Create an event
Delete a history category
Delete an event and related files
Get all history categories
Get filtered events
Update a history category
Update a history category icon
Update the order of history categories
Invoices
Check invoice existence by number
Create an invoice
Create an invoice item
Create an invoice line
Create an invoice tax
Delete an invoice
Delete an invoice group
Delete an invoice item
Delete an invoice line
Delete an invoice tax
Delete invoice items
Get an invoice by ID
Get an invoice by number
Get an invoice item by ID
Get an invoice sample
Get entity invoices
Get filtered invoices
Get invoice converter data
Get invoice taxes
Get invoices
Get the default invoice settings
Get the invoice JSON data
Get the invoice pdf file
Save the default setting for invoice terms
Save the default settings for invoice number
Update an invoice
Update an invoice group status
Update an invoice item
Update an invoice line
Update an invoice tax
Opportunities
Add an opportunity contact
Create an opportunity
Create an opportunity stage
Delete an opportunity
Delete an opportunity contact
Delete an opportunity stage
Delete filtered opportunities
Delete opportunities by IDs
Get all opportunity stages
Get an opportunity by ID
Get an opportunity stage
Get contact opportunities
Get filtered opportunities
Get opportunity contacts
Set access rights to the filtered opportunities
Set access rights to the opportunities by IDs
Set access rights to the opportunity
Update an opportunity
Update an opportunity stage by ID
Update an opportunity stage by parameters
Update an opportunity stage color
Update the order of opportunity stages
Organisation
Get an organisation logo
Update a company name
Update the company address
Update the organisation logo setting
Reports
Check report data
Delete a report file
Generate a report
Get report files
Get report generation state
Terminate the report generation
Tags
Add a tag to a case group
Add a tag to a contact group
Add a tag to an opportunity group
Add a tag to the entities
Add a tag to the entity
Add a tag to the entity and related contacts
Create a tag
Delete a tag from the entities
Delete a tag from the entity
Delete a tag from the entity and related contacts
Delete unused tags
Get contact tags
Get entity tags
Get tags for entity type
Tasks
Close a task
Create a task
Create a task category
Delete a task
Delete a task category
Get a task category
Get all task categories
Get task by ID
Get tasks
Reopen a task
Update a task
Update a task category
Update a task category icon
Update the order of task categories
Voip
Add operators
Answer a call
Buy a phone number
Delete a phone number
Delete an operator
Delete an uploaded file
Get a call
Get a phone number
Get a token
Get all phone numbers
Get available phone numbers
Get calls
Get missed calls
Get operators
Get the current phone number
Get the links to the uploaded files
Get unlinked phone numbers
Get voip settings
Link a phone number
Make a call
Redirect a call
Reject a call
Save a call
Save a call price
Update an operator
Update phone number settings
Update voip settings
feed
Count fresh feeds
Get feeds
Read feeds
files
Files
Add favorite files and folders
Add template files
Change history
Create a file
Create a file in my section
Delete favorite files and folders
Delete template files
Get file versions
Get the file information
Open the editor
Save editing
Start editing
Track editing
Update a file
Update file content
Folders
Create a folder
Get a folder by ID
Get common section
Get favorite section
Get my section
Get project section
Get recent section
Get sections
Get shared section
Get template section
Get the folder information
Get the folder path
Get trash section
Rename a folder
Operations
Bulk download
Check files and folders for conflicts
Clear recycle bin
Copy to a folder
Delete a file
Delete a folder
Delete files and folders
Finish all operations
Get converting status
Get operations
Mark as read
Move to a folder
Search files and folders
Start file converting
Settings
Change the archive format
Check the document service URL
Display favorite folder
Display recent folder
Display template folder
Get the document service URL
Store original formats
Update a file version if exists
Sharing
Get the shared file information
Get the shared folder information
Get the shared link
Remove group sharing rights
Share a file
Share a folder
Third-party integration
Get common third-party services
Get providers
Get third-party services
Remove a third-party account
Save a third-party account
Uploads
Chunked upload
Insert a file
Insert a file to my section
Insert a file to the common section
Upload a file
Upload a file to my section
Upload a file to the common section
group
Add a new group
Add group members
Delete a group
Get a group
Get all groups
Get user groups
Move group members
Remove group members
Set a group manager
Set group members
Update a group
mail
Accounts
Create an account by custom mail servers
Create an account by email and password
Create the OAuth account
Delete an account
Get an account by email
Get the default account settings
Get user accounts
Set an account state
Set the account email in a folder
Set the default account
Update an account
Update the OAuth account
Update the user activity state
Alerts
Delete an alert by ID
Get alerts
Autoreply
Update an autoreply
Contacts
Create a mail contact
Get contacts by contact information
Get contacts by search query
Get the linked CRM entities
Remove mail contacts
Search contacts by email
Update a mail contact
Conversations
Add a tag to the conversations
Check a conversation CRM status
Get a conversation
Get filtered conversations
Get the previous or next conversation ID
Link a conversation to CRM
Mark a conversation as CRM linked
Move conversations to the folder
Remove a tag from the conversations
Remove conversations
Restore conversations
Set a conversation status
Unmark a conversation as CRM linked
Filters
Apply a filter
Check filter results
Create a filter
Delete a filter
Get filters
Update a filter
Folders
Create a folder
Delete a folder
Get a folder by mail ID
Get the default folders
Get the user folders
Remove folder messages
Update a folder
Help center
Get help center page HTML
Images
Add the trusted image address
Get trusted image addresses
Remove the trusted image address
Messages
Add a calendar
Add an attachment
Attach the Teamlab document
Delete an attachment from the message
Download attachments
Export a message to CRM
Export an attachment
Export message attachments
Get a message
Get a message template
Get filtered messages
Get the previous or next message ID
Move messages to the folder
Reassign drafts/templates
Remove messages
Restore messages
Save a message as a draft
Send a message
Set a message status
Operations
Get a status of complex mail operation
Get running complex mail operations
Settings
Get common settings
Get the "Always display images" flag
Get the "Cache unread messages" flag
Get the "Enable conversations" flag
Get the "Go next after move" flag
Get the "Replace message body" flag
Set the "Always display images" flag
Set the "Cache unread messages" flag
Set the "Enable Conversations" flag
Set the "Go next after move" flag
Set the "Replace message body" flag
Signature
Get a signature
Update a signature
Tags
Create a tag
Delete a tag
Get tags
Remove a tag from the messages
Set a tag to the messages
Update a tag
Templates
Save a message as a template
mailserver
Address data
Add a mailbox alias
DNS records
Get DNS records by domain ID
Get or create free DNS records
Domains
Add a domain to the mail server
Check the domain name existence
Check the domain ownership
Get common web domain
Get web domains
Remove a domain from the mail server
Mail groups
Add an address to the mail group
Create a mail group
Get mail groups
Remove a mail group
Remove an address from the mail group
Mailboxes
Change a mailbox password
Check the mailbox address existence
Create a mailbox
Create my mailbox
Get mailboxes
Remove a mailbox alias
Remove a mailbox from the mail server
Update a mailbox
Validate the mailbox address
Notifications
Create the notification address
Remove the notification address
Servers
Get the mail server
Get the mail server information
people
Affiliate programm
Join to the affiliate programm
Contacts
Delete user contacts
Set user contacts
Update user contacts
Photos
Create a photo thumbnail
Delete a user photo
Get a user photo
Update a user photo
Profiles
Add a user
Delete a user
Delete users
Get a profile by user email
Get a profile by user name
Get all profiles
Get my profile
Import users
Resend an activation email
Send the delete instructions
Update a user
Reassign user data
Get the reassigning progress
Start the reassigning process
Terminate the reassigning process
Remove user data
Get the removing progress
Start the removing process
Terminate the removing process
Search
Search user profiles
Search users
Search users and their information by extended filter
Search users by extended filter
Search users by status filter
User status
Change a user status
Get a user status
Get profiles by status
User type
Change a user type
portal
Backup
Create the backup schedule
Delete the backup
Delete the backup history
Delete the backup schedule
Get the backup history
Get the backup progress
Get the backup schedule
Get the restoring progress
Start the backup
Start the restoring process
Quota
Get a portal quota
Get a portal tariff
Get the recommended quota
Get the used portal space
Search
Check the search availability
Get the search settings
Reindex a page
Set the search settings
Users
Get a number of portal users
Get a user by ID
Get an invitation link
Get the current portal
project
Comments
Add a message comment
Add a project comment
Add a task comment
Get a comment
Get a comment preview
Get message comments
Get task comments
Remove a comment
Update a comment
Contacts
Add a project contact
Delete a project contact
Get contact projects
Discussions
Add a message
Check subscription to discussion
Delete a message
Get a message
Get a message preview
Get messages
Get messages by filter
Get recent messages
Get subscribers
Subscribe to discussion
Update a message
Update a message status
Files
Detach a file from a message
Detach a file from a task
Get entity files
Get message files
Get project files by project ID
Get task files
Upload files to the message
Upload files to the task
Milestones
Add a milestone
Delete a milestone
Delete milestones
Get a milestone
Get milestone tasks
Get milestones
Get milestones by deadline
Get milestones by deadline month
Get milestones by filter
Get milestones by project ID
Get milestones by project ID and milestone status
Get overdue milestones
Update a milestone
Update a milestone status
Projects
Create a project
Create a project with team security
Delete a project
Delete projects
Get a project by ID
Get filtered projects
Get my followed projects
Get my projects
Get projects
Get projects by status
Project subscription
Search in a project
Search projects
Update a project
Update a project status
Update a project with team security
Report
Check the report data
Create a report template
Delete a report template
Get a report status
Get a report template
Get generated reports
Remove the generated report
Terminate the reporting process
Update a report template
Settings
Get settings
Update settings
Tags
Create a tag
Get project tags
Get projects by a tag
Get tags by a tag name
Update a project tag
Update project tags
Tasks
Add a link between tasks
Add a task
Add a task by message ID
Check the subscription to task actions
Copy a subtask
Copy a task
Create a subtask
Create a task status
Delete a subtask
Delete a task
Delete a task status
Delete tasks
Get a task
Get my tasks
Get my tasks by status
Get my tasks by status and project ID
Get task statuses
Get tasks
Get tasks by filter
Get tasks by status
Notify the task responsible
Remove a link between tasks
Subscribe to task actions
Update a milestone of tasks
Update a status of tasks
Update a subtask
Update a subtask status
Update a task
Update a task milestone
Update a task status
Update a task status by task ID
Update task statuses
Teams
Add a user to the team
Get a project team
Get a project team with excluded members
Get team members of projects
Remove a user from the team
Set team security
Update a project team
Templates
Create a template
Delete a template
Get a template by ID
Get templates
Update a template
Time
Add task time
Delete task time
Get project time
Get task time
Get task time by filter
Get total project time
Get total task time by filter
Update a time status of payment
Update task time
settings
Common settings
Get a portal logo
Get the portal settings
Get the socket settings
Update the email activation settings
Custom navigation
Add a custom navigation item
Delete a custom navigation item
Get a custom navigation item by ID
Get a custom navigation item sample
Get the custom navigation items
IP restrictions
Get the IP portal restrictions
Save the IP restrictions
Update the IP restriction settings
LDAP
Get the LDAP cron expression
Get the LDAP default settings
Get the LDAP settings
Get the LDAP synchronization process status
Save the LDAP settings
Set the LDAP cron expression
Synchronize by LDAP
Test the LDAP saving process
Test the LDAP synchronization
Quota
Check quota recalculating
Get the space usage
Recalculates quota
Security
Check the product administrator
Get the module availability
Get the password settings
Get the product administrators
Get the security settings
Set access to web items
Set the product administrator
Set the security settings
SMTP
Get the SMTP settings
Get the SMTP test process status
Reset the SMTP settings
Save the SMTP settings
Test the SMTP settings
SSO
Get the constants of the SSO settings
Get the default SSO settings
Get the SSO settings
Reset the SSO settings
Save the SSO settings
Statistics
Get the space usage statistics
Get the visit statistics
Storage
Get storages
Get the backup storages
Get the CDN storages
Get the storage progress
Reset the CDN storage settings
Reset the storage settings
Update a storage
Update the CDN storage
Telegram
Check the Telegram connection
Unlink Telegram Bot
TFA settings
Request the new TFA codes
Unlink the TFA application
Update the TFA settings
Tips
Update the tip settings
Update the tip subscription
More information
FAQ
Filtering
Batching
notifications
Name
Resource
Description
Create the notification address
POST
api/2.0/mailserver/notification/address/add
Creates an address for the tenant notifications with the parameters specified in the request.
Remove the notification address
DELETE
api/2.0/mailserver/notification/address/remove
Deletes an address for the tenant notification specified in the request.