customer-engagement
people
person-profile

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.

patch/people/3/persons/upsert

Request

  • Base URL
    https://api.infobip.com (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Client credentials
      Token URL: https://api.infobip.com/auth/1/oauth2/token
    • or API key in header Authorization
    • or API key in header Authorization
    • or HTTP basic

Request body

Example request

{
  "persons": [
    {
      "id": 1,
      "externalId": "3",
      "type": "CUSTOMER",
      "firstName": "Jane",
      "middleName": "Janie",
      "lastName": "Smith",
      "nickName": "Janey",
      "country": "United Kingdom",
      "city": "London",
      "address": "67 Farringdon Road",
      "gender": "FEMALE",
      "preferredLanguage": "en-gb",
      "birthDate": "1966-01-15",
      "profilePicture": "http://profile.com",
      "tags": [
        "tag1",
        "tag2"
      ],
      "contactInformation": [
        {
          "type": "PHONE",
          "identifier": "41793026727",
          "sender": "41793026728",
          "primary": true
        }
      ],
      "customAttributes": {
        "Contract Expiry": "2024-06-12",
        "Company": "ACME"
      },
      "computedAttributes": {
        "fullName": "Jane Smith"
      },
      "createdFrom": "API",
      "createdBy": "5",
      "modifiedFrom": "API",
      "modifiedBy": "5"
    }
  ]
}

Response

Multi-Status - Batch operation completed with individual results

Changes

No recorded changes to this operation across all 1 revision of this API.