curl --request POST \
  --url https://api.messaging.phonovation.com/people/3/persons/merge \
  --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
    }
  ]
}

customer-engagement

Batch merge profiles

Use this method to merge multiple person profiles belonging to the same user based on matching identifiers such as external ID, email, phone, and other contact information. The standard merge logic applies: the system selects a primary profile and consolidates fields and events from the secondary profiles into it. More information about the merge logic is available in the [People documentation](https://www.phonovation.com/docs/people/synchronize-your-audience#merge-duplicate). <br>Any data included in the merge request overrides what is already stored. If the request provides a new external ID or new contact information, it is written into the resulting profile, either replacing the existing identifier or being added to the contact list, depending on the type. <br>If the merge request includes only new identifiers or contact information that match no existing profile, the system creates a new profile and populates it entirely with the data from the request. <br>**Notes:** <br>1. The batch size limit is 1000 persons. <br>2. Contact information in the request is checked only for formal validity (emails and phone numbers). Ensure its correctness, alignment with configured senders, and absence of errors. **Required scope:** Enable one of: `people:read`, `people:manage`.

POST

/

people

/

3

/

persons

/

merge

curl --request POST \
  --url https://api.messaging.phonovation.com/people/3/persons/merge \
  --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
    }
  ]
}

Authorizations

Authorization

string

header

default:App

required

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

persons

MergePersonV3DocsSchema · object[]

required

Required array length: 1 - 1000 elements

Show child attributes

Response

Multi-Status - Batch operation completed with individual results

Batch response for upsert operations

errors

ErrorResponseV3 · object

Error information for failed batch operation items.

Show child attributes

results

MergeSuccessResult · object

Successful result for a person merge operation.

Show child attributes