Contacts API - en
- Yulia Zatsarinnaya Smart Sender
- Smart Sender
Using this API, you can view, find, add, edit, merge, and delete contacts in a project.
Receipt.
Allows you to get a list of contacts in the project.
GET https://api.smartsender.com/v1/contacts
Main parameters:
Name | Description | Validation |
|---|---|---|
page | Requested Page | Minimum value 1 |
limitation | Amount of data to display per page | Minimum value 1, maximum 20 |
In case of a successful response, you will receive the following:
{
"cursor": Cursor,
"collection": Contact[]
}
Answer description:
Search.
Allows you to find matches for contacts using a keyword.
GET https://api.smartsender.com/v1/contacts/search
Main parameters:
Name | Description | Validation |
|---|---|---|
page | Requested Page | Minimum value 1 |
limitation | Amount of data to display per page | Minimum value 1, maximum 20 |
term | Search keyword | not empty |
In case of a successful response, you will receive the following:
Answer description:
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.
In this method, variables will be passed as a key-value without detailed information about the variables themselves.
Search chat by ID.
Getting a contact's chat by ID.
In case of a successful response, get an object of type Chat.
Search for available communications by ID.
Get a list of available communications for a contact by ID.
Main parameters:
Name | Description | Validation |
|---|---|---|
page | Requested Page | Minimum value 1 |
limitation | Amount of data to display per page | Minimum value 1, maximum 20 |
In case of a successful response, you will receive the following:
Answer description:
Update.
Updates the data of the selected client.
Basic Parameters: Specify all required parameters for the update in the request body. It can be both variables and system fields.
Main parameters:
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:
Launching an event.
Triggers the selected event for the contact.
Main parameters:
Name | Description |
|---|---|
name | Event name, case sensitive |
In case of a successful response, you will receive the following:
Unification.
Connects one client with another. All tags, funnels, variables will be synchronized in favor of {contactId}, and all missing values will be taken from {targetContactId}.
In case of a successful response, you will receive the following:
(DEPRECATED) Delete
Allows you to delete the selected contact.
In case of a successful response, you will receive the following:
Creation.
Contact creation is only available for the Smart Messenger platform using the Channels API (gateway creation). To do this you need a channel ID.