Infobip People API

Build rich profiles for each person to create audience segments for more precise targeting. Manage duplicates and import your data over API. Events reflect actions that end users take on your website or in your mobile application. Events API is a robust way to send those events to Infobip. — 37 operation path(s) and 0 webhook(s) in Infobip's published OpenAPI.

OpenAPI Specification

infobip-people-openapi.json Raw ↑
{
 "openapi":"3.1.0",
 "info":{
  "title":"Infobip OpenAPI Specification",
  "description":"OpenAPI Specification that contains all public endpoints and webhooks.",
  "contact":{
   "name":"Infobip support",
   "email":"support@infobip.com"
  },
  "version":"3.210.0",
  "x-generatedAt":"2026-07-23T15:24:00.803279678Z"
 },
 "tags":[
  {
   "name":"customer-engagement",
   "description":"Complete solutions that will help you drive better outcomes for your customers and business across the entire customer journey.\n",
   "x-type":"category",
   "x-displayName":"Customer Engagement"
  },
  {
   "name":"people",
   "description":"Build rich profiles for each person to create audience segments for more precise targeting. Manage duplicates and import your data over API.\n\nEvents reflect actions that end users take on your website or in your mobile application.\n\nEvents API is a robust way to send those events to Infobip. Event can be sent only to an existing person in People module and an event definition should be created beforehand to describe contents of the event.\n\nOther events tracking options:\n* [ JavaScript SDK ](https://github.com/infobip/people-web-sdk)\n* [iOS SDK](https://github.com/infobip/mobile-messaging-sdk-ios/wiki/Events)\n* [Android SDK](https://github.com/infobip/mobile-messaging-sdk-android/wiki/Events)\n",
   "x-type":"product",
   "x-displayName":"People"
  },
  {
   "name":"person-profile",
   "description":"",
   "x-type":"section",
   "x-displayName":"Person profile"
  },
  {
   "name":"company-profile",
   "description":"",
   "x-type":"section",
   "x-displayName":"Company profile"
  },
  {
   "name":"tags",
   "description":"",
   "x-type":"section",
   "x-displayName":"Tags"
  },
  {
   "name":"custom-attributes",
   "description":"",
   "x-type":"section",
   "x-displayName":"Custom attributes"
  },
  {
   "name":"custom-attributes-lists",
   "description":"",
   "x-type":"section",
   "x-displayName":"Custom attributes: Lists"
  },
  {
   "name":"contact-information:-push",
   "description":"",
   "x-type":"section",
   "x-displayName":"Contact Information: Push"
  },
  {
   "name":"events",
   "description":"",
   "x-type":"section",
   "x-displayName":"Events"
  },
  {
   "name":"segments",
   "description":"",
   "x-type":"section",
   "x-displayName":"Segments"
  }
 ],
 "paths":{
  "/people/2/persons":{
   "get":{
    "tags":[
     "customer-engagement",
     "people",
     "person-profile"
    ],
    "summary":"Get a single person or a list of people",
    "description":"Use this method with a unique person identifier to get a single person. Skip the identifier to return all people or use the `filter` parameter to return a list of people matching your specific conditions.",
    "operationId":"get-a-single-person-or-a-list-of-people",
    "parameters":[
     {
      "name":"identifier",
      "in":"query",
      "description":"Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"370329180020364"
     },
     {
      "name":"sender",
      "in":"query",
      "description":"Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"2094832040560427"
     },
     {
      "name":"type",
      "in":"query",
      "description":"Type of the person ID",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "allOf":[
        {
         "$ref":"#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType"
        }
       ]
      },
      "example":"PHONE"
     },
     {
      "name":"limit",
      "in":"query",
      "description":"Number of persons to return per page. Default - 20. Maximum - 1000.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      },
      "example":"20"
     },
     {
      "name":"page",
      "in":"query",
      "description":"Page of results to return. Default - 1.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"integer",
       "format":"int32"
      },
      "example":"1"
     },
     {
      "name":"includeTotalCount",
      "in":"query",
      "description":"Returns total count of persons, if set to `true`.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"boolean"
      },
      "example":"false"
     },
     {
      "name":"orderBy",
      "in":"query",
      "description":"Results ordering. Possible ordering fields are `firstName`, `lastName`, `createdAt` and `modifiedAt`. Ordering direction can be specified with modifiers `asc` for the ascending ordering or `desc` for the descending one.",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"modifiedAt:desc"
     },
     {
      "name":"filter",
      "in":"query",
      "description":"Allows to filter persons using simple queries. Just pass to the parameter [URL encoded](https://www.w3schools.com/tags/ref_urlencode.asp) query.\n##### List of supported logical operators:\n\n<table>\n<thead>\n<th>Logical Operator</th><th>Description</th>\n</thead>\n<tr>\n<td><code>#and</code></td><td>Joins query clauses with a logical AND returns all records that match the conditions of both clauses.</td>\n</tr>\n<tr>\n<td><code>#or</code></td><td>Joins query clauses with a logical OR returns all records that match the conditions of either clause.</td>\n</tr>\n</table>\n\n##### List of supported comparison operators:\n\n<table>\n<thead>\n<th>Comparison Operator</th><th>Supported Type</th><th>Description</th>\n</thead>\n<tr>\n<td><code>#eq</code></td><td>string, integer, decimal, date</td><td>Matches values that are equal to a specified value.</td>\n</tr>\n<tr>\n<td><code>#ne</code></td><td>string, integer, decimal, date</td><td>Matches all values that are not equal to a specified value.</td>\n</tr>\n<tr>\n<td><code>#contains</code></td><td>string</td><td>Matches the records that contain the specified value.</td>\n</tr>\n<tr>\n<td><code>#notContain</code></td><td>string</td><td>Matches the records that does not contain the specified value.</td>\n</tr>\n<tr>\n<td><code>#startsWith</code></td><td>string</td><td>Matches the records that start with a specified value.</td>\n</tr>\n<tr>\n<td><code>#endsWith</code></td><td>string</td><td>Matches the records that end with a specified value.</td>\n</tr>\n<tr>\n<td><code>#gt</code></td><td>integer, decimal, date</td><td>Matches values that are greater than a specified value.</td>\n</tr>\n<tr>\n<td><code>#lt</code></td><td>integer, decimal, date</td><td>Matches values that are less than a specified value.</td>\n</tr>\n<tr>\n<td><code>#gte</code></td><td>integer, decimal, date</td><td>Matches values that are greater than or equal to a specified value.</td>\n</tr>\n<tr>\n<td><code>#lte</code></td><td>integer, decimal, date</td><td>Matches values that are less than or equal to a specified value.</td>\n</tr>\n</table>\n",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"{\"#and\":[{\"firstName\":\"Alex\"},{\"#contains\": { \"tags\":\"VIP Client\"}}]}}"
     }
    ],
    "responses":{
     "200":{
      "description":"successful response",
      "content":{
       "application/json":{
        "schema":{
         "allOf":[
          {
           "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2"
          }
         ]
        },
        "examples":{
         "Person response":{
          "summary":"Person response",
          "value":{
           "createdAt":"2018-03-29T13:46:31",
           "modifiedAt":"2018-03-30T11:25:13",
           "id":1,
           "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",
           "origin":"API",
           "modifiedFrom":"API",
           "tags":[
            "VIP Customers",
            "New Customers"
           ],
           "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":{
            "phone":[
             {
              "number":"41793026727"
             }
            ],
            "email":[
             {
              "address":"janewilliams@acme.com"
             }
            ],
            "push":[
             {
              "applicationId":"FDCC8516470A3AE97FB8AC218D5D0D3D",
              "registrationId":"c5db0c47-465c-4e1c-abf8-7cedc275dd19",
              "additionalData":{
               "birthdate":"1988-07-31",
               "email":"test@test.com",
               "firstName":"Jane",
               "gender":"F",
               "lastName":"Smith",
               "middleName":"Janie"
              },
              "systemData":{
               "cloudType":"GCM",
               "registrationEnabled":"true",
               "sdkName":"MobileMessaging SDK",
               "os":"Android"
              }
             }
            ],
            "facebook":[
             {
              "applicationId":"370329180020364",
              "userId":"2094832040560427",
              "systemData":{
               "gender":"female",
               "lastName":"Smith",
               "firstName":"Jane"
              }
             }
            ],
            "line":[
             {
              "applicationId":"1644264921",
              "userId":"U045147f1ad961bfe996b72bbf417f3c9",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "instagram":[
             {
              "applicationId":"17841446795352028",
              "userId":"12461436693342628",
              "systemData":{
               "displayName":"jane.smith"
              }
             }
            ],
            "twitter":[
             {
              "applicationId":"1148203323283877",
              "userId":"370329180020364",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "appleBusinessChat":[
             {
              "applicationId":"387465931",
              "userId":"387465931",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "zaloFollower":[
             {
              "applicationId":"12345678901",
              "userId":"9876543210",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "tiktokBm":[
             {
              "applicationId":"7012345678901234567",
              "userId":"7123456789012345678",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "whatsapp":[
             {
              "applicationId":"441234567890",
              "userId":"US.13491208655302741918",
              "systemData":{
               "username":"jane.smith"
              }
             }
            ]
           }
          }
         }
        }
       },
       "application/xml":{
        "schema":{
         "allOf":[
          {
           "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2"
          }
         ]
        },
        "examples":{
         "Person response":{
          "summary":"Person response",
          "value":"<?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>"
         }
        }
       }
      }
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "4XX":{
      "description":"Error responses",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       },
       "application/xml":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     },
     "5XX":{
      "description":"Error responses",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       },
       "application/xml":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       }
      }
     }
    },
    "security":[
     {
      "Basic":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "IBSSOTokenHeader":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "people:manage",
     "people:read"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "put":{
    "tags":[
     "customer-engagement",
     "people",
     "person-profile"
    ],
    "summary":"Update a person",
    "description":"Use this method to overwrite a person profile with the data passed in the request body as follows:<br>1. New values for standard and custom profile attributes replace existing values on the profile. If no value is passed in the request, the attribute is set to empty.<br>2. Tags in the request replace the existing profile tags. If no tags are passed, the existing profile tag list is cleared.<br>3. New contact information (email addresses and phone numbers) in the request replaces the current information on the profile.",
    "operationId":"update-a-person",
    "parameters":[
     {
      "name":"identifier",
      "in":"query",
      "description":"Person ID. ID type must match the `type` parameter. Some channels (e,g., Apple Business Chat) use identifiers that contain unsafe characters. Make sure you URL-encode them in your API request",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"370329180020364"
     },
     {
      "name":"sender",
      "in":"query",
      "description":"Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "type":"string"
      },
      "example":"2094832040560427"
     },
     {
      "name":"type",
      "in":"query",
      "description":"Type of the person ID",
      "required":false,
      "style":"form",
      "explode":true,
      "schema":{
       "allOf":[
        {
         "$ref":"#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType"
        }
       ]
      },
      "example":"PHONE"
     }
    ],
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "allOf":[
         {
          "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2"
         }
        ]
       },
       "examples":{
        "Update person with list":{
         "summary":"Update person with list",
         "value":{
          "firstName":"Jane",
          "lastName":"Smith",
          "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":{
           "email":[
            {
             "address":"janewilliams@acme.com"
            }
           ]
          }
         }
        }
       }
      },
      "application/xml":{
       "schema":{
        "allOf":[
         {
          "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2"
         }
        ]
       },
       "examples":{
        "Update person with list":{
         "summary":"Update person with list",
         "value":"<?xml version='1.0' encoding='UTF-8'?><IamPersonV2><firstName>Jane</firstName><lastName>Smith</lastName><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><email><email><address>janewilliams@acme.com</address></email></email></contactInformation></IamPersonV2>"
        }
       }
      }
     }
    },
    "responses":{
     "200":{
      "description":"successful response",
      "content":{
       "application/json":{
        "schema":{
         "allOf":[
          {
           "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2"
          }
         ]
        },
        "examples":{
         "Person response":{
          "summary":"Person response",
          "value":{
           "createdAt":"2018-03-29T13:46:31",
           "modifiedAt":"2018-03-30T11:25:13",
           "id":1,
           "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",
           "origin":"API",
           "modifiedFrom":"API",
           "tags":[
            "VIP Customers",
            "New Customers"
           ],
           "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":{
            "phone":[
             {
              "number":"41793026727"
             }
            ],
            "email":[
             {
              "address":"janewilliams@acme.com"
             }
            ],
            "push":[
             {
              "applicationId":"FDCC8516470A3AE97FB8AC218D5D0D3D",
              "registrationId":"c5db0c47-465c-4e1c-abf8-7cedc275dd19",
              "additionalData":{
               "birthdate":"1988-07-31",
               "email":"test@test.com",
               "firstName":"Jane",
               "gender":"F",
               "lastName":"Smith",
               "middleName":"Janie"
              },
              "systemData":{
               "cloudType":"GCM",
               "registrationEnabled":"true",
               "sdkName":"MobileMessaging SDK",
               "os":"Android"
              }
             }
            ],
            "facebook":[
             {
              "applicationId":"370329180020364",
              "userId":"2094832040560427",
              "systemData":{
               "gender":"female",
               "lastName":"Smith",
               "firstName":"Jane"
              }
             }
            ],
            "line":[
             {
              "applicationId":"1644264921",
              "userId":"U045147f1ad961bfe996b72bbf417f3c9",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "instagram":[
             {
              "applicationId":"17841446795352028",
              "userId":"12461436693342628",
              "systemData":{
               "displayName":"jane.smith"
              }
             }
            ],
            "twitter":[
             {
              "applicationId":"1148203323283877",
              "userId":"370329180020364",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "appleBusinessChat":[
             {
              "applicationId":"387465931",
              "userId":"387465931",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "zaloFollower":[
             {
              "applicationId":"12345678901",
              "userId":"9876543210",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "tiktokBm":[
             {
              "applicationId":"7012345678901234567",
              "userId":"7123456789012345678",
              "systemData":{
               "displayName":"Jane Smith"
              }
             }
            ],
            "whatsapp":[
             {
              "applicationId":"441234567890",
              "userId":"US.13491208655302741918",
              "systemData":{
               "username":"jane.smith"
              }
             }
            ]
           }
          }
         }
        }
       },
       "application/xml":{
        "schema":{
         "allOf":[
          {
           "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2"
          }
         ]
        },
        "examples":{
         "Person response":{
          "summary":"Person response",
          "value":"<?xml version='1.0' encoding='UTF-8'?><IamPersonV2><createdAt>2018-03-29T13:46:31</createdAt><modifiedAt>2018-03-30T11:25:13</modifiedAt><id>1</id><externalId>3</externalId><firstName>Jane</firstName><lastName>Smith</lastName><address>67 Farringdon Road</address><city>London</city><country>United Kingdom</country><gender>FEMALE</gender><birthDate>1966-01-15</birthDate><middleName>Janie</middleName><preferredLanguage>en-gb</preferredLanguage><profilePicture>http://profile.com</profilePicture><origin>API</origin><modifiedFrom>API</modifiedFrom><tags><tags>VIP Customers</tags><tags>New Customers</tags></tags><customAttributes><Contract Expiry>2018-06-01</Contract Expiry><Company>Acme</Company><ShoppingCartList><productName>Sneakers</productName><productPrice>25.33</productPrice><productCategory>Sport Sneakers</productCategory><productImage>/image1.png</productImage></ShoppingCartList><ShoppingCartList><productName>T-Shirt</productName><productPrice>9.99</productPrice><productCategory>Casual</productCategory><productImage>/image2.png</productImage></ShoppingCartList></customAttributes><contactInformation><phone><phone><number>41793026727</number></phone></phone><email><email><address>janewilliams@acme.com</address></email></email><push><push><applicationId>FDCC8516470A3AE97FB8AC218D5D0D3D</applicationId><registrationId>c5db0c47-465c-4e1c-abf8-7cedc275dd19</registrationId><additionalData><birthdate>1988-07-31</birthdate><email>test@test.com</email><firstName>Jane</firstName><gender>F</gender><lastName>Smith</lastName><middleName>Janie</middleName></additionalData><systemData><cloudType>GCM</cloudType><registrationEnabled>true</registrationEnabled><sdkName>MobileMessaging SDK</sdkName><os>Android</os></systemData></push></push><facebook><facebook><applicationId>370329180020364</applicationId><userId>2094832040560427</userId><systemData><gender>female</gender><lastName>Smith</lastName><firstName>Jane</firstName></systemData></facebook></facebook><line><line><applicationId>1644264921</applicationId><userId>U045147f1ad961bfe996b72bbf417f3c9</userId><systemData><displayName>Jane Smith</displayName></systemData></line></line><instagram><instagram><applicationId>17841446795352028</applicationId><userId>12461436693342628</userId><systemData><displayName>jane.smith</displayName></systemData></instagram></instagram><twitter><twitter><applicationId>1148203323283877</applicationId><userId>370329180020364</userId><systemData><displayName>Jane Smith</displayName></systemData></twitter></twitter><appleBusinessChat><appleBusinessChat><applicationId>387465931</applicationId><userId>387465931</userId><systemData><displayName>Jane Smith</displayName></systemData></appleBusinessChat></appleBusinessChat><zaloFollower><zaloFollower><applicationId>12345678901</applicationId><userId>9876543210</userId><systemData><displayName>Jane Smith</displayName></systemData></zaloFollower></zaloFollower><tiktokBm><tiktokBm><applicationId>7012345678901234567</applicationId><userId>7123456789012345678</userId><systemData><displayName>Jane Smith</displayName></systemData></tiktokBm></tiktokBm><whatsapp><whatsapp><applicationId>441234567890</applicationId><userId>US.13491208655302741918</userId><systemData><username>jane.smith</username></systemData></whatsapp></whatsapp></contactInformation></IamPersonV2>"
         }
        }
       }
      }
     },
     "400":{
      "$ref":"#/components/responses/ApiException400"
     },
     "401":{
      "$ref":"#/components/responses/ApiException401"
     },
     "403":{
      "$ref":"#/components/responses/ApiException403"
     },
     "429":{
      "$ref":"#/components/responses/ApiException429"
     },
     "4XX":{
      "description":"Error responses",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       },
       "application/xml":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       }
      }
     },
     "500":{
      "$ref":"#/components/responses/ApiException500"
     },
     "5XX":{
      "description":"Error responses",
      "content":{
       "application/json":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       },
       "application/xml":{
        "schema":{
         "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException"
        }
       }
      }
     }
    },
    "security":[
     {
      "Basic":[]
     },
     {
      "APIKeyHeader":[]
     },
     {
      "IBSSOTokenHeader":[]
     },
     {
      "OAuth2":[]
     }
    ],
    "x-scopes":[
     "people:manage"
    ],
    "x-throttling-info":[
     {
      "type":"time",
      "numberOfRequests":5,
      "numberOfTimeUnits":0,
      "timeUnit":"s"
     }
    ]
   },
   "post":{
    "tags":[
     "customer-engagement",
     "people",
     "person-profile"
    ],
    "summary":"Create a new person",
    "description":"Use this method to create a new person.",
    "operationId":"create-a-new-person",
    "requestBody":{
     "content":{
      "application/json":{
       "schema":{
        "allOf":[
         {
          "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2"
         }
        ]
       },
       "examples":{
        "Create person with list":{
         "summary":"Create person with list",
         "value":{
          "firstName":"Jane",
          "lastName":"Smith",
          "customAttributes":{
           "Contract Expiry":"2018-06-01",
           "Company":"Acme",
           "ShoppingCartList":[
            {
          

# --- truncated at 32 KB (637 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/infobip/refs/heads/main/openapi/infobip-people-openapi.json