Contacts API - en

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:

Name	Description
cursor	Type object Cursor
collection	Array of type objects Contact

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:

{
    "cursor": Cursor,
    "collection": Contact[]
}

Answer description:

Name	Description
cursor	Type object Cursor
collection	Array of type objects Contact

Search by ID.

Getting information about a contact by ID.

GET https://api.smartsender.com/v1/contacts/{contactId}

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

Search by ID (simple).

Getting information about a contact by ID.

GET https://api.smartsender.com/v1/contacts/{contactId}/info

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.

GET https://api.smartsender.com/v1/contacts/{contactId}/chat

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.

GET https://api.smartsender.com/v1/contacts/{contactId}/gates

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": Gate[]
}

Answer description:

Name	Description
cursor	Type object Cursor
collection	Array of type objects Gate

Update.

Updates the data of the selected client.

PUT https://api.smartsender.com/v1/contacts/{contactId}

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:

{
    "state": true
}

Launching an event.

Triggers the selected event for the contact.

POST https://api.smartsender.com/v1/contacts/{contactId}/fire

Main parameters:

Name	Description
name	Event name, case sensitive

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

{
    "state": true
}

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}.

POST https://api.smartsender.com/v1/contacts/{contactId}/unite/{targetContactId}

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

{
    "state": true
}

(DEPRECATED) Delete

Allows you to delete the selected contact.

DELETE https://api.smartsender.com/v1/contacts/{contactId}

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

{
    "state": true
}