Contacts
Want to tie conversations across messaging channels to a single contact? Airy allows you to do that and then sync these contacts to your existing CRM solutions.
note
This feature is disabled by default. To enable it you need to set the integration.contacts.enabled
field in
your airy.yaml config to true
.
Enabling the contacts component allows for this typical flow:
- For every existing conversation we automatically create a contact that references the conversation
- Contacts can then also be manually created, updated, fetched and importantly: merged
See the create contact response payload for an example of what the schema looks like.
#
Create contactPOST /contacts.create
Sample request
All request fields are optional, but an empty payload will not be accepted.
(201) Success Response Payload
#
List recent messagesPOST /contacts.recent-messages
Sample request
Sample response
#
Import contactsPOST /contacts.import
Creates contacts in a bulk.
Sample request
(201) Success Response Payload
#
List contactsPOST /contacts.list
This is a paginated endpoint.
Sample request
Sample response
#
Get contactGet a single contact by contact or conversation id.
POST /contacts.info
Sample request by contact id
Sample request by conversation id
Sample response
#
Update contactPOST /contacts.update
All fields set on the creation request can be updated. To remove a field set it to the empty
string ""
.
Sample request
Sample response 202 (Accepted)
#
Delete contactSample request
(202) Sample response
#
Merge contactsPOST /contacts.merge
Merge the source contact into the destination one, only the fields that are not present on the destination contact will be merged, a copy of the source contact will be saved in the merge history
Sample request
(200) Success Response Payload