curl --request PATCH \
--url https://api.messaging.phonovation.com/people/3/persons/upsert \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"persons": [
{
"externalId": "3",
"firstName": "Jane",
"lastName": "Smith",
"address": "67 Farringdon Road",
"city": "London",
"country": "United Kingdom",
"gender": "FEMALE",
"birthDate": "1966-01-15",
"middleName": "Janie",
"preferredLanguage": "en-gb",
"profilePicture": "http://profile.com",
"customAttributes": {
"Contract Expiry": "2018-06-01",
"Company": "Acme",
"ShoppingCartList": [
{
"productName": "Sneakers",
"productPrice": 25.33,
"productCategory": "Sport Sneakers",
"productImage": "/image1.png"
},
{
"productName": "T-Shirt",
"productPrice": 9.99,
"productCategory": "Casual",
"productImage": "/image2.png"
}
]
},
"contactInformation": [
{
"identifier": "john.doe@example.com",
"type": "EMAIL"
},
{
"identifier": "353861234579",
"type": "PHONE"
}
],
"tags": [
"VIP Customers",
"New Customers"
]
}
]
}
'{
"errors": [],
"results": [
{
"id": 12345,
"index": 0,
"status": "CREATED"
}
]
}customer-engagement
Batch partial people upsert
Use this method to create or partially update person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is updated only with the provided data; any fields excluded from the request remain unchanged. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED. <br>**Notes:** <br>1. The batch size limit is 1000 persons. <br>2. Contact information (emails and phone numbers) in the request is checked only for formal validity. Ensure accuracy and absence of errors.
**Required scope:** Enable one of: `people:read`, `people:manage`.
PATCH
/
people
/
3
/
persons
/
upsert
curl --request PATCH \
--url https://api.messaging.phonovation.com/people/3/persons/upsert \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"persons": [
{
"externalId": "3",
"firstName": "Jane",
"lastName": "Smith",
"address": "67 Farringdon Road",
"city": "London",
"country": "United Kingdom",
"gender": "FEMALE",
"birthDate": "1966-01-15",
"middleName": "Janie",
"preferredLanguage": "en-gb",
"profilePicture": "http://profile.com",
"customAttributes": {
"Contract Expiry": "2018-06-01",
"Company": "Acme",
"ShoppingCartList": [
{
"productName": "Sneakers",
"productPrice": 25.33,
"productCategory": "Sport Sneakers",
"productImage": "/image1.png"
},
{
"productName": "T-Shirt",
"productPrice": 9.99,
"productCategory": "Casual",
"productImage": "/image2.png"
}
]
},
"contactInformation": [
{
"identifier": "john.doe@example.com",
"type": "EMAIL"
},
{
"identifier": "353861234579",
"type": "PHONE"
}
],
"tags": [
"VIP Customers",
"New Customers"
]
}
]
}
'{
"errors": [],
"results": [
{
"id": 12345,
"index": 0,
"status": "CREATED"
}
]
}Authorizations
This is the most secure authorization type and the one with the most flexibility.
API keys can be generated by calling the dedicated API method. Furthermore, API keys can have a limited scope and cover only some API methods. Lastly, they can be revoked at any time. This range of possibilities makes API keys well suited for separating the API access rights across multiple applications or use cases. Finally, the loss of an API key is easily manageable.
You can manage your API keys from GUI, or programmatically with dedicated API.
API key Authorization header example:
Authorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
Body
application/json
Required array length:
1 - 1000 elementsShow child attributes
Show child attributes
Response
Multi-Status - Batch operation completed with individual results