Contacts
Search Contact
POST /integrations/contacts/search
Search for a contact within Nteraction.
Request
Filter
- id – search against the contact ID (returns only contacts where the entire ID matches)
- search – Search against all default contact fields (excludes contact custom properties)
- firstName – search within the contact first name field
- lastName – Search within the contact last name field
- email – Search within the contact email address field
- phoneNumber – Search within the contact phone number field
- whatsApp – Search within the contact WhatsApp number field
- properties – Search within a list of contact custom properties (name/value pair)
Pagination
- size – page size
- number – page number to return (zero-based)
- sort – results sort-by field
Sample Request
JSON
{
"filter": {
"search": "string",
"id": "string",
"firstName": "string",
"lastName": "string",
"email": "string",
"phoneNumber": "string",
"whatsApp": "string",
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
},
"page": {
"size": 0,
"number": 0,
"sort": "string"
}
}
Response
- items – array of contacts (limited to the requested page size).
- id – contact ID
- firstName – contact first name field
- lastName – contact last name field
- emailAddresses – contact email addresses
- phoneNumbers – contact phone numbers
- whatsAppNumbers – contact WhatsApp numbers
- properties – list of contact custom non-null properties (name/value pair)
- errors – array of errors (type/value). Empty if successful.
- totalCount – total number of contacts that meet the search criteria
Sample Response
JSON
{
"items": [
{
"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddresses": [
"string"
],
"phoneNumbers": [
"string"
],
"whatsAppNumbers": [
"string"
],
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"errors": [
{
"type": "string",
"value": "string"
}
]
}
],
"totalCount": 0
}
Create Contact
POST /integrations/contacts/create
Creates a new contact or updates an existing one (matching is performed against the email address, phone or WhatsApp number).
Additional properties will be created on the contact if they didn’t previously exist.
Request
- firstName – contact first name field
- lastName – contact last name field
- emailAddresses – array of contact email addresses
- phoneNumbers – array of contact phone numbers
- whatsApp – array of contact WhatsApp numbers
- properties – list of contact custom properties (name/value pair)
Sample Request
JSON
{
"firstName": "string",
"lastName": "string",
"emailAddresses": [
"string"
],
"phoneNumbers": [
"string"
],
"whatsAppNumbers": [
"string"
],
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
Response
- id – Contact ID of created/updated contact.
- firstName – the First name
- lastName – the Last name
- emailAddresses – array of email addresses
- phoneNumbers – array of phone numbers
- whatsAppNumbers – array of WhatsApp numbers
- properties – list of non-null custom properties (name/value pair)
- errors – array of errors (type/value). Empty if create/update was successful.
Sample Response
JSON
{
"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddresses": [
"string"
],
"phoneNumbers": [
"string"
],
"whatsAppNumbers": [
"string"
],
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"errors": [
{
"type": "string",
"value": "string"
}
]
}
Update Contact
POST /integrations/contacts/update
Updates contact by ContactID. Additional properties will be created if they did not previously exist
Request
- id – Contact ID
- firstName – contact first name field
- lastName – contact last name field
- emailAddresses – array of contact email addresses
- phoneNumbers – array of contact phone numbers
- whatsApp – array of contact WhatsApp numbers
- properties – list of contact custom properties (name/value pair)
Sample Request
JSON
{
"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddresses": [
"string"
],
"phoneNumbers": [
"string"
],
"whatsAppNumbers": [
"string"
],
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
}
}
Response
- id – Contact ID of created/updated contact.
- firstName – the First name
- lastName – the Last name
- emailAddresses – array of email addresses
- phoneNumbers – array of phone numbers
- whatsAppNumbers – array of WhatsApp numbers
- properties – list of non-null custom properties (name/value pair)
- errors – array of errors (type/value). Empty if create/update was successful.
Sample Response
JSON
{
"id": "string",
"firstName": "string",
"lastName": "string",
"emailAddresses": [
"string"
],
"phoneNumbers": [
"string"
],
"whatsAppNumbers": [
"string"
],
"properties": {
"additionalProp1": "string",
"additionalProp2": "string",
"additionalProp3": "string"
},
"errors": [
{
"type": "string",
"value": "string"
}
]
}
Contact Custom Properties
POST /integrations/contacts/properties
Retrieves a list of all available contact custom properties. No request parameters.
Request
N/A
Response
Array of contact properties.
key – unique property key
label – property title
Sample Response
JSON
[
{
"key": "string",
"label": "string"
}
]
