Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Using this API, you can view, find, add, edit, merge, and delete contacts in a project.

...

Name

Description

cursor

Type object Cursor

collection

Array of type objects Contact

 

Search.

Allows you to find matches for contacts using a keyword.

...

Name

Description

cursor

Type object Cursor

collection

Array of type objects Contact

 

Search by ID.

Getting information about a contact by ID.

...

 
In case of a successful response, get an object of type Contact.

 

Search by ID (simple).

Getting information about a contact by ID.

...

 
In case of a successful response, get an object of type Contact.

Info

In this method, variables will be passed as a key-value without detailed information about the variables themselves.

...

 
In case of a successful response, get an object of type Chat.

 

Search for available communications by ID.

...

Name

Description

cursor

Type object Cursor

collection

Array of type objects Gate

 

Update.

Updates the data of the selected client.

...

Name

Type

Description

values

Object (key-value)

All necessary parameters for updating in the body of the request. It can be both variables and system fields.

 

Important! If an invalid value is specified for a field update, the field will be skipped and the rest of the update will be processed.

In case of a successful response, you will receive the following:

...

Code Block
{
    "state": true
}

 

(DEPRECATED) Delete

Allows you to delete the selected contact. 

...