{ "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\n\n\n\n\n\n\n\n\n\n
Logical OperatorDescription
#andJoins query clauses with a logical AND returns all records that match the conditions of both clauses.
#orJoins query clauses with a logical OR returns all records that match the conditions of either clause.
\n\n##### List of supported comparison operators:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Comparison OperatorSupported TypeDescription
#eqstring, integer, decimal, dateMatches values that are equal to a specified value.
#nestring, integer, decimal, dateMatches all values that are not equal to a specified value.
#containsstringMatches the records that contain the specified value.
#notContainstringMatches the records that does not contain the specified value.
#startsWithstringMatches the records that start with a specified value.
#endsWithstringMatches the records that end with a specified value.
#gtinteger, decimal, dateMatches values that are greater than a specified value.
#ltinteger, decimal, dateMatches values that are less than a specified value.
#gteinteger, decimal, dateMatches values that are greater than or equal to a specified value.
#lteinteger, decimal, dateMatches values that are less than or equal to a specified value.
\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":"2018-03-29T13:46:312018-03-30T11:25:1313JaneSmith
67 Farringdon Road
LondonUnited KingdomFEMALE1966-01-15Janieen-gbhttp://profile.comAPIAPIVIP CustomersNew Customers2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png41793026727
janewilliams@acme.com
FDCC8516470A3AE97FB8AC218D5D0D3Dc5db0c47-465c-4e1c-abf8-7cedc275dd191988-07-31test@test.comJaneFSmithJanieGCMtrueMobileMessaging SDKAndroid3703291800203642094832040560427femaleSmithJane1644264921U045147f1ad961bfe996b72bbf417f3c9Jane Smith1784144679535202812461436693342628jane.smith1148203323283877370329180020364Jane Smith387465931387465931Jane Smith123456789019876543210Jane Smith70123456789012345677123456789012345678Jane Smith441234567890US.13491208655302741918jane.smith" } } } } }, "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:
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.
2. Tags in the request replace the existing profile tags. If no tags are passed, the existing profile tag list is cleared.
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":"JaneSmith2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png
janewilliams@acme.com
" } } } } }, "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":"2018-03-29T13:46:312018-03-30T11:25:1313JaneSmith
67 Farringdon Road
LondonUnited KingdomFEMALE1966-01-15Janieen-gbhttp://profile.comAPIAPIVIP CustomersNew Customers2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png41793026727
janewilliams@acme.com
FDCC8516470A3AE97FB8AC218D5D0D3Dc5db0c47-465c-4e1c-abf8-7cedc275dd191988-07-31test@test.comJaneFSmithJanieGCMtrueMobileMessaging SDKAndroid3703291800203642094832040560427femaleSmithJane1644264921U045147f1ad961bfe996b72bbf417f3c9Jane Smith1784144679535202812461436693342628jane.smith1148203323283877370329180020364Jane Smith387465931387465931Jane Smith123456789019876543210Jane Smith70123456789012345677123456789012345678Jane Smith441234567890US.13491208655302741918jane.smith" } } } } }, "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":[ { "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":{ "Create person with list":{ "summary":"Create person with list", "value":"JaneSmith2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png
janewilliams@acme.com
" } } } } }, "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" } } ] } } }, "Response of create person with list":{ "summary":"Response of create person with list", "value":{ "createdAt":"2018-03-29T13:46:31", "modifiedAt":"2018-03-30T11:25:13", "id":1, "firstName":"Jane", "lastName":"Smith", "origin":"API", "modifiedFrom":"API", "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":{ "Person response":{ "summary":"Person response", "value":"2018-03-29T13:46:312018-03-30T11:25:1313JaneSmith
67 Farringdon Road
LondonUnited KingdomFEMALE1966-01-15Janieen-gbhttp://profile.comAPIAPIVIP CustomersNew Customers2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png41793026727
janewilliams@acme.com
FDCC8516470A3AE97FB8AC218D5D0D3Dc5db0c47-465c-4e1c-abf8-7cedc275dd191988-07-31test@test.comJaneFSmithJanieGCMtrueMobileMessaging SDKAndroid3703291800203642094832040560427femaleSmithJane1644264921U045147f1ad961bfe996b72bbf417f3c9Jane Smith1784144679535202812461436693342628jane.smith1148203323283877370329180020364Jane Smith387465931387465931Jane Smith123456789019876543210Jane Smith70123456789012345677123456789012345678Jane Smith441234567890US.13491208655302741918jane.smith" }, "Response of create person with list":{ "summary":"Response of create person with list", "value":"2018-03-29T13:46:312018-03-30T11:25:131JaneSmithAPIAPI2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png
janewilliams@acme.com
" } } } } }, "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":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Delete a person", "description":"Use this method to delete a person.", "operationId":"delete-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" } ], "responses":{ "200":{ "description":"successful response" }, "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" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Partial person update", "description":"Use this method to update a person profile with the data passed in the request body as follows:
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 keeps its value.
2. Tags in the request are appended to the profile tag list.
3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.", "operationId":"partial-person-update", "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":{ "setNewListToPerson":{ "summary":"Add new list to person or replace existed one", "value":{ "customAttributes":{ "ShoppingCartList":[ { "productName":"Sneakers", "productPrice":25.33, "productCategory":"Sport Sneakers", "productImage":"/image1.png" }, { "productName":"T-Shirt", "productPrice":9.99, "productCategory":"Casual", "productImage":"/image2.png" } ] } } } } } } }, "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" } } ] } } }, "Response of set the whole new list for person":{ "summary":"Response of set the whole new list for person", "value":{ "createdAt":"2018-03-29T13:46:31", "modifiedAt":"2018-03-30T11:25:13", "id":1, "firstName":"Jane", "lastName":"Smith", "origin":"API", "modifiedFrom":"API", "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":{ "Person response":{ "summary":"Person response", "value":"2018-03-29T13:46:312018-03-30T11:25:1313JaneSmith
67 Farringdon Road
LondonUnited KingdomFEMALE1966-01-15Janieen-gbhttp://profile.comAPIAPIVIP CustomersNew Customers2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png41793026727
janewilliams@acme.com
FDCC8516470A3AE97FB8AC218D5D0D3Dc5db0c47-465c-4e1c-abf8-7cedc275dd191988-07-31test@test.comJaneFSmithJanieGCMtrueMobileMessaging SDKAndroid3703291800203642094832040560427femaleSmithJane1644264921U045147f1ad961bfe996b72bbf417f3c9Jane Smith1784144679535202812461436693342628jane.smith1148203323283877370329180020364Jane Smith387465931387465931Jane Smith123456789019876543210Jane Smith70123456789012345677123456789012345678Jane Smith441234567890US.13491208655302741918jane.smith" }, "Response of set the whole new list for person":{ "summary":"Response of set the whole new list for person", "value":"2018-03-29T13:46:312018-03-30T11:25:131JaneSmithAPIAPI2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png
janewilliams@acme.com
" } } } } }, "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" } ] } }, "/people/2/persons/contactInformation":{ "put":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Set contact information to person", "description":"Use this method to replace contact information for a particular person. This methods will replace all existing emails and mobile phones with new contact information.", "operationId":"set-person-contact-information", "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/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest" } ] } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest" } ] } } } }, "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":"2018-03-29T13:46:312018-03-30T11:25:1313JaneSmith
67 Farringdon Road
LondonUnited KingdomFEMALE1966-01-15Janieen-gbhttp://profile.comAPIAPIVIP CustomersNew Customers2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png41793026727
janewilliams@acme.com
FDCC8516470A3AE97FB8AC218D5D0D3Dc5db0c47-465c-4e1c-abf8-7cedc275dd191988-07-31test@test.comJaneFSmithJanieGCMtrueMobileMessaging SDKAndroid3703291800203642094832040560427femaleSmithJane1644264921U045147f1ad961bfe996b72bbf417f3c9Jane Smith1784144679535202812461436693342628jane.smith1148203323283877370329180020364Jane Smith387465931387465931Jane Smith123456789019876543210Jane Smith70123456789012345677123456789012345678Jane Smith441234567890US.13491208655302741918jane.smith" } } } } }, "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" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Delete contact information from person", "description":"Use this method to delete specified emails and mobile phones from a particular person.", "operationId":"delete-person-contact-information", "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/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest" } ] } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest" } ] } } } }, "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":"2018-03-29T13:46:312018-03-30T11:25:1313JaneSmith
67 Farringdon Road
LondonUnited KingdomFEMALE1966-01-15Janieen-gbhttp://profile.comAPIAPIVIP CustomersNew Customers2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png41793026727
janewilliams@acme.com
FDCC8516470A3AE97FB8AC218D5D0D3Dc5db0c47-465c-4e1c-abf8-7cedc275dd191988-07-31test@test.comJaneFSmithJanieGCMtrueMobileMessaging SDKAndroid3703291800203642094832040560427femaleSmithJane1644264921U045147f1ad961bfe996b72bbf417f3c9Jane Smith1784144679535202812461436693342628jane.smith1148203323283877370329180020364Jane Smith387465931387465931Jane Smith123456789019876543210Jane Smith70123456789012345677123456789012345678Jane Smith441234567890US.13491208655302741918jane.smith" } } } } }, "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" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Add contact information to person", "description":"Use this method to add emails and mobile phones to a particular person.", "operationId":"add-person-contact-information", "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/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest" } ] } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest" } ] } } } }, "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":"2018-03-29T13:46:312018-03-30T11:25:1313JaneSmith
67 Farringdon Road
LondonUnited KingdomFEMALE1966-01-15Janieen-gbhttp://profile.comAPIAPIVIP CustomersNew Customers2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png41793026727
janewilliams@acme.com
FDCC8516470A3AE97FB8AC218D5D0D3Dc5db0c47-465c-4e1c-abf8-7cedc275dd191988-07-31test@test.comJaneFSmithJanieGCMtrueMobileMessaging SDKAndroid3703291800203642094832040560427femaleSmithJane1644264921U045147f1ad961bfe996b72bbf417f3c9Jane Smith1784144679535202812461436693342628jane.smith1148203323283877370329180020364Jane Smith387465931387465931Jane Smith123456789019876543210Jane Smith70123456789012345677123456789012345678Jane Smith441234567890US.13491208655302741918jane.smith" } } } } }, "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" } ] } }, "/people/2/persons/batch":{ "post":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Batch people create", "description":"Use this method to create multiple persons.
**NOTE** Array size of the batch create request is limited to `1000` persons.", "operationId":"batch-people-create", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateRequest" } ] }, "examples":{ "Batch people create":{ "summary":"Batch people create", "value":{ "people":[ { "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/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateRequest" } ] }, "examples":{ "Batch people create":{ "summary":"Batch people create", "value":"JaneSmith2018-06-01AcmeSneakers25.33Sport Sneakers/image1.pngT-Shirt9.99Casual/image2.png
janewilliams@acme.com
" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse" } ] }, "examples":{ "Batch people create":{ "summary":"Batch people create", "value":{ "results":[ { "errors":[ { "message":"Destination(email) janewilliams@acme.com already exists." } ], "status":409, "index":0 } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse" } ] }, "examples":{ "Batch people create":{ "summary":"Batch people create", "value":"\n \n \n \n \n Destination(email) janewilliams@acme.com already exists.\n \n \n 409\n 0\n \n \n\n" } } } } }, "207":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse" } ] }, "examples":{ "Batch people create":{ "summary":"Batch people create", "value":{ "results":[ { "errors":[ { "message":"Destination(email) janewilliams@acme.com already exists." } ], "status":409, "index":0 } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse" } ] }, "examples":{ "Batch people create":{ "summary":"Batch people create", "value":"\n \n \n \n \n Destination(email) janewilliams@acme.com already exists.\n \n \n 409\n 0\n \n \n\n" } } } } }, "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" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Batch people delete", "description":"Use this method to delete multiple persons.
**NOTE** Array size of the batch delete request is limited to `1000` persons.", "operationId":"batch-people-delete", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteRequest" } ] }, "examples":{ "Batch people delete":{ "summary":"Batch people delete", "value":{ "people":[ { "query":{ "type":"PHONE", "identifier":"41793026727" } }, { "query":{ "type":"EMAIL", "identifier":"johnwilliams@acme.com" } }, { "query":{ "type":"EXTERNAL_ID", "identifier":"123" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteRequest" } ] }, "examples":{ "Batch people delete":{ "summary":"Batch people delete", "value":"\n \n \n \n PHONE\n 41793026727\n \n \n \n \n EMAIL\n johnwilliams@acme.com\n \n \n \n \n EXTERNAL_ID\n 123\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse" } ] }, "examples":{ "Batch people delete":{ "summary":"Batch people delete", "value":{ "results":[ { "errors":[ { "message":"There is no person matching the query" } ], "status":409, "query":{ "type":"PHONE", "identifier":"41793026727" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse" } ] }, "examples":{ "Batch people delete":{ "summary":"Batch people delete", "value":"\n \n \n \n \n There is no person matching the query\n \n \n 409\n \n PHONE\n 41793026727\n \n \n \n\n" } } } } }, "207":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse" } ] }, "examples":{ "Batch people delete":{ "summary":"Batch people delete", "value":{ "results":[ { "errors":[ { "message":"There is no person matching the query" } ], "status":409, "query":{ "type":"PHONE", "identifier":"41793026727" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse" } ] }, "examples":{ "Batch people delete":{ "summary":"Batch people delete", "value":"\n \n \n \n \n There is no person matching the query\n \n \n 409\n \n PHONE\n 41793026727\n \n \n \n\n" } } } } }, "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" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Batch people update", "description":"Use this method to update multiple person profiles with the data passed in the request body as follows:
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 keeps its value.
2. Tags in the request are appended to the profile tag list.
3. New contact information (email addresses and phone numbers) in the request is appended to the contact list of the profile.
**NOTE** Array size of the batch update request is limited to `1000` persons.", "operationId":"batch-people-update", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "type":"object", "properties":{ "people":{ "type":"array", "description":"List of people.", "items":{ "type":"object", "properties":{ "query":{ "allOf":[ { "$ref":"#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery" } ] }, "update":{ "allOf":[ { "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2" } ] } } } } }, "title":"Batch people update" } ] }, "examples":{ "batchPeopleUpdate":{ "summary":"batchPeopleUpdate", "value":{ "people":[ { "query":{ "identifier":"dab3a9cf-e8d0-42cf-9b2b-4745a8fff", "type":"EXTERNAL_ID" }, "update":{ "firstName":"Jack", "lastName":"Smith", "customAttributes":{ "displayName":"jacky" }, "contactInformation":{ "phone":[ { "number":"44598123467" } ] } } }, { "query":{ "identifier":"41793026727", "type":"PHONE" }, "update":{ "firstName":"Jane", "lastName":"Smith" } } ] } } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse" } ] }, "examples":{ "Batch people update":{ "summary":"Batch people update", "value":{ "results":[ { "errors":[ { "message":"There is no person matching the query" } ], "status":409, "query":{ "type":"PHONE", "identifier":"41793026727" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse" } ] }, "examples":{ "Batch people update":{ "summary":"Batch people update", "value":"\n \n \n \n \n There is no person matching the query\n \n \n 409\n \n PHONE\n 41793026727\n \n \n \n\n" } } } } }, "207":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse" } ] }, "examples":{ "Batch people update":{ "summary":"Batch people update", "value":{ "results":[ { "errors":[ { "message":"There is no person matching the query" } ], "status":409, "query":{ "type":"PHONE", "identifier":"41793026727" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse" } ] }, "examples":{ "Batch people update":{ "summary":"Batch people update", "value":"\n \n \n \n \n There is no person matching the query\n \n \n 409\n \n PHONE\n 41793026727\n \n \n \n\n" } } } } }, "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" } ] } }, "/people/2/persons/match":{ "post":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Match profiles", "description":"Use this method to match a list of identities against existing person profiles in People. For each successfully matched identity the internal ID of the person profile will be returned. Duplicate identities will fetch a single profile reference.", "operationId":"match-people-ids", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "identities":[ { "type":"EXTERNAL_ID", "identifier":"XXX" }, { "type":"PHONE", "identifier":"XXXXXXXXXXX" } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "matches":[ { "type":"EMAIL", "identifier":"example@example.com", "personId":1 }, { "type":"PUSH", "identifier":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "sender":"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "personId":2 } ] } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{} } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "*/*":{ "schema":{ "type":"object" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":15, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/persons/merge":{ "post":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Batch merge profiles", "description":"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.infobip.com/docs/people/synchronize-your-audience#merge-duplicate).
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.
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.
**Notes:**
1. The batch size limit is 1000 persons.
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.", "operationId":"merge-persons", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeRequestDocsSchema" }, "examples":{ "valid request - single person":{ "summary":"valid request - single person", "description":"valid request - single person", "value":{ "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":"41793026727", "type":"PHONE" } ], "tags":[ "VIP Customers", "New Customers" ] } ] } }, "valid request - multiple persons":{ "summary":"valid request - multiple persons", "description":"valid request - multiple persons", "value":{ "persons":[ { "externalId":"3", "firstName":"Jane" }, { "externalId":"4", "city":"Paris" }, { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example.com", "type":"EMAIL" } ] } ] } }, "Mixed valid and invalid request":{ "summary":"Mixed valid and invalid request", "description":"Mixed valid and invalid request", "value":{ "persons":[ { "externalId":"3", "firstName":"Jane" }, { "firstName":"Joe", "contactInformation":[ { "identifier":"000", "type":"PHONE" } ] }, { "externalId":"4", "city":"Paris" } ] } }, "all invalid request":{ "summary":"all invalid request", "description":"all invalid request", "value":{ "persons":[ { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example.com" } ] }, { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example", "type":"EMAIL" } ] } ] } } } } }, "required":true }, "responses":{ "207":{ "description":"Multi-Status - Batch operation completed with individual results", "content":{ "application/json":{ "schema":{ "type":"object", "description":"Batch response for upsert operations", "properties":{ "errors":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3" }, "results":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeSuccessResult" } } }, "examples":{ "Successful merge - Single person":{ "summary":"Successful merge - Single person", "description":"Single person successfully merged", "value":{ "errors":[], "results":[ { "id":12345, "index":0 } ] } }, "Successful merge - Multiple persons":{ "summary":"Successful merge - Multiple persons", "description":"Multiple persons successfully merged", "value":{ "errors":[], "results":[ { "id":12345, "index":0 }, { "id":12346, "index":1 }, { "id":12347, "index":2 } ] } }, "mixed success and validation errors":{ "summary":"mixed success and validation errors", "description":"Some persons merged successfully, others failed validation", "value":{ "errors":[ { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[1].contactInformation[0].identifier", "message":"Phone number is invalid" } ], "index":1 } ], "results":[ { "id":12345, "index":0 }, { "id":12347, "index":2 } ] } }, "all validation errors":{ "summary":"all validation errors", "description":"All persons in the batch failed validation", "value":{ "errors":[ { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[0].contactInformation[0].type", "message":"Must not be null" } ], "index":0 }, { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[1].contactInformation[0].identifier", "message":"Email address is invalid" } ], "index":1 } ], "results":[] } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "malformed JSON":{ "summary":"malformed JSON", "description":"malformed JSON", "value":{ "code":400103, "message":"Malformed JSON body, wrong syntax" } }, "missing required property":{ "summary":"missing required property", "description":"missing required property", "value":{ "code":400104, "message":"Missing required property 'persons'", "details":[ { "property":"persons", "message":"Required, but value is missing" } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/persons/upsert":{ "put":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Batch full people upsert", "description":"Use this method to create or fully replace person profiles by matching on identifiers such as external ID, email, or phone. If a match is identified, the existing profile is entirely replaced with the provided data; any fields excluded from the request will be cleared. If no match is identified, a new profile is created. The operation returns a status for each profile: CREATED, UPDATED, or NOT_MODIFIED.
**Notes:**
1. The batch size limit is 1000 persons.
2. Contact information (emails and phone numbers) in the request is checked only for formal validity. Ensure accuracy and absence of errors.", "operationId":"upsert-persons-full", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertRequestDocsSchema" }, "examples":{ "valid request - single person":{ "summary":"valid request - single person", "description":"valid request - single person", "value":{ "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":"41793026727", "type":"PHONE" } ], "tags":[ "VIP Customers", "New Customers" ] } ] } }, "valid request - multiple persons":{ "summary":"valid request - multiple persons", "description":"valid request - multiple persons", "value":{ "persons":[ { "externalId":"3", "firstName":"Jane" }, { "externalId":"4", "city":"Paris" }, { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example.com", "type":"EMAIL" } ] } ] } }, "mixed valid and invalid request":{ "summary":"mixed valid and invalid request", "description":"mixed valid and invalid request", "value":{ "persons":[ { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example", "type":"EMAIL" } ] }, { "externalId":"4", "city":"Paris" } ] } }, "all invalid request":{ "summary":"all invalid request", "description":"all invalid request", "value":{ "persons":[ { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example", "type":"EMAIL" } ] }, { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example" } ] } ] } } } } }, "required":true }, "responses":{ "207":{ "description":"Multi-Status - Batch operation completed with individual results", "content":{ "application/json":{ "schema":{ "type":"object", "description":"Batch response for upsert operations", "properties":{ "errors":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3" }, "results":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertSuccessResult" } } }, "examples":{ "Successful upsert - Single person created":{ "summary":"Successful upsert - Single person created", "description":"Single person successfully created", "value":{ "errors":[], "results":[ { "id":12345, "index":0, "status":"CREATED" } ] } }, "Successful upsert - Multiple persons with different statuses":{ "summary":"Successful upsert - Multiple persons with different statuses", "description":"Multiple persons processed with different operation results", "value":{ "errors":[], "results":[ { "id":1, "index":0, "status":"NOT_MODIFIED" }, { "id":2, "index":1, "status":"UPDATED" }, { "id":3, "index":2, "status":"CREATED" } ] } }, "Mixed success and validation errors":{ "summary":"Mixed success and validation errors", "description":"Some persons processed successfully, others failed validation", "value":{ "errors":[ { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[0].contactInformation[0].identifier", "message":"Email address is invalid" } ], "index":0 } ], "results":[ { "id":2, "index":1, "status":"NOT_MODIFIED" } ] } }, "All validation errors":{ "summary":"All validation errors", "description":"All persons in the batch failed validation", "value":{ "errors":[ { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[0].contactInformation[0].identifier", "message":"Email address is invalid" } ], "index":0 }, { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[1].contactInformation[0].type", "message":"Must not be null" } ], "index":1 } ], "results":[] } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "malformed JSON":{ "summary":"malformed JSON", "description":"malformed JSON", "value":{ "code":400103, "message":"Malformed JSON body, wrong syntax" } }, "missing required property":{ "summary":"missing required property", "description":"missing required property", "value":{ "code":400104, "message":"Missing required property 'persons'", "details":[ { "property":"persons", "message":"Required, but value is missing" } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "person-profile" ], "summary":"Batch partial people upsert", "description":"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.
**Notes:**
1. The batch size limit is 1000 persons.
2. Contact information (emails and phone numbers) in the request is checked only for formal validity. Ensure accuracy and absence of errors.", "operationId":"upsert-persons-partial", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertRequestDocsSchema" }, "examples":{ "valid request - single person":{ "summary":"valid request - single person", "description":"valid request - single person", "value":{ "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":"41793026727", "type":"PHONE" } ], "tags":[ "VIP Customers", "New Customers" ] } ] } }, "valid request - multiple persons":{ "summary":"valid request - multiple persons", "description":"valid request - multiple persons", "value":{ "persons":[ { "externalId":"3", "firstName":"Jane" }, { "externalId":"4", "city":"Paris" }, { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example.com", "type":"EMAIL" } ] } ] } }, "mixed valid and invalid request":{ "summary":"mixed valid and invalid request", "description":"mixed valid and invalid request", "value":{ "persons":[ { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example", "type":"EMAIL" } ] }, { "externalId":"4", "city":"Paris" } ] } }, "all invalid request":{ "summary":"all invalid request", "description":"all invalid request", "value":{ "persons":[ { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example", "type":"EMAIL" } ] }, { "firstName":"Joe", "contactInformation":[ { "identifier":"john.doe@example" } ] } ] } } } } }, "required":true }, "responses":{ "207":{ "description":"Multi-Status - Batch operation completed with individual results", "content":{ "application/json":{ "schema":{ "type":"object", "description":"Batch response for upsert operations", "properties":{ "errors":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3" }, "results":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertSuccessResult" } } }, "examples":{ "Successful upsert - Single person created":{ "summary":"Successful upsert - Single person created", "description":"Single person successfully created", "value":{ "errors":[], "results":[ { "id":12345, "index":0, "status":"CREATED" } ] } }, "Successful upsert - Multiple persons with different statuses":{ "summary":"Successful upsert - Multiple persons with different statuses", "description":"Multiple persons processed with different operation results", "value":{ "errors":[], "results":[ { "id":1, "index":0, "status":"NOT_MODIFIED" }, { "id":2, "index":1, "status":"UPDATED" }, { "id":3, "index":2, "status":"CREATED" } ] } }, "Mixed success and validation errors":{ "summary":"Mixed success and validation errors", "description":"Some persons processed successfully, others failed validation", "value":{ "errors":[ { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[0].contactInformation[0].identifier", "message":"Email address is invalid" } ], "index":0 } ], "results":[ { "id":2, "index":1, "status":"NOT_MODIFIED" } ] } }, "All validation errors":{ "summary":"All validation errors", "description":"All persons in the batch failed validation", "value":{ "errors":[ { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[0].contactInformation[0].identifier", "message":"Email address is invalid" } ], "index":0 }, { "code":400100, "message":"One or more properties of the person are invalid", "details":[ { "property":"persons[1].contactInformation[0].type", "message":"Must not be null" } ], "index":1 } ], "results":[] } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "malformed JSON":{ "summary":"malformed JSON", "description":"malformed JSON", "value":{ "code":400103, "message":"Malformed JSON body, wrong syntax" } }, "missing required property":{ "summary":"missing required property", "description":"missing required property", "value":{ "code":400104, "message":"Missing required property 'persons'", "details":[ { "property":"persons", "message":"Required, but value is missing" } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/companies":{ "get":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Get a single company or a list of companies", "description":"Use this method with a query parameter to get a single company. If the query parameter is not specified, this method will return a list of companies.", "operationId":"get-a-single-company-by-name-or-a-list-of-companies", "parameters":[ { "name":"name", "in":"query", "description":"Name of company you want to get.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Infobip" }, { "name":"id", "in":"query", "description":"ID of company you want to get.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int64" }, "example":"11351351" }, { "name":"externalId", "in":"query", "description":"External ID of company you want to get.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"11351351" }, { "name":"domain", "in":"query", "description":"Domain of company you want to get.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"www.infobip.com" }, { "name":"limit", "in":"query", "description":"Number of companies 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 companies, 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 `name`, `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 companies 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\n\n\n\n\n\n\n\n\n\n
Logical OperatorDescription
#andJoins query clauses with a logical AND returns all records that match the conditions of both clauses.
#orJoins query clauses with a logical OR returns all records that match the conditions of either clause.
\n\n##### List of supported comparison operators:\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Comparison OperatorSupported TypeDescription
#eqstring, integer, decimal, dateMatches values that are equal to a specified value.
#nestring, integer, decimal, dateMatches all values that are not equal to a specified value.
#containsstringMatches the records that contain a specified value.
#startsWithstringMatches the records that start with a specified value.
#endsWithstringMatches the records that end with a specified value.
#gtinteger, decimal, dateMatches values that are greater than a specified value.
#ltinteger, decimal, dateMatches values that are less than a specified value.
#gteinteger, decimal, dateMatches values that are greater than or equal to a specified value.
#lteinteger, decimal, dateMatches values that are less than or equal to a specified value.
\n", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"{\"#or\":[{\"name\":\"infobip\"},{\"#contains\":{\"notes\":\"another\"}}]}" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.CompaniesResponse" } ] }, "examples":{ "Get single company response":{ "summary":"Get single company response", "value":{ "companies":[ { "createdAt":"2017-12-01T19:16:41", "modifiedAt":"2017-12-01T19:16:41", "id":1, "name":"Infobip", "notes":"notes example", "country":"Croatia", "region":"Europe", "accountManager":"Jane Smith", "customerStage":"Active", "industry":"IT", "vatNumber":"003212059", "customAttributes":{ "Contract Expiry":"2018-06-01" }, "domains":[ "infobip.com" ], "tags":[ "Vip" ], "origin":"API", "modifiedFrom":"API" } ] } }, "Get companies response":{ "summary":"Get companies response", "value":{ "companies":[ { "createdAt":"2017-12-01T19:16:41", "modifiedAt":"2017-12-01T19:16:41", "id":1, "name":"Infobip", "notes":"notes example", "country":"Croatia", "region":"Europe", "accountManager":"Jane Smith", "customerStage":"Active", "industry":"IT", "vatNumber":"003212059", "customAttributes":{ "Contract Expiry":"2018-06-01" }, "domains":[ "infobip.com" ], "tags":[ "Vip" ], "origin":"API", "modifiedFrom":"API" }, { "createdAt":"2018-12-01T19:16:41", "modifiedAt":"2018-12-01T19:16:41", "id":2, "name":"Google", "notes":"notes example", "country":"UK", "region":"Europe", "accountManager":"Jack Smith", "customerStage":"Active", "industry":"IT", "vatNumber":"003212060", "customAttributes":{ "Contract Expiry":"2019-06-01" }, "domains":[ "google-uk.com" ], "tags":[ "Vip" ], "origin":"API", "modifiedFrom":"API" } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.CompaniesResponse" } ] }, "examples":{ "Get single company response":{ "summary":"Get single company response", "value":"2017-12-01T19:16:412017-12-01T19:16:411Infobipnotes exampleCroatiaEuropeJane SmithActiveIT0032120592018-06-01infobip.comVipAPIAPI" }, "Get companies response":{ "summary":"Get companies response", "value":"2017-12-01T19:16:412017-12-01T19:16:411Infobipnotes exampleCroatiaEuropeJane SmithActiveIT0032120592018-06-01infobip.comVipAPIAPI2018-12-01T19:16:412018-12-01T19:16:412Googlenotes exampleUKEuropeJack SmithActiveIT0032120602019-06-01google-uk.comVipAPIAPI" } } } } }, "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-is-early-access":true, "x-scopes":[ "people:manage", "people:read" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Create a new company", "description":"Use this method to create a new company.", "operationId":"create-company", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] }, "examples":{ "Create company":{ "summary":"Create company", "value":{ "name":"Infobip", "notes":"notes example", "country":"Croatia", "region":"Europe", "accountManager":"Jane Smith", "customerStage":"Active", "industry":"IT", "vatNumber":"003212059", "customAttributes":{ "Contract Expiry":"2018-06-01" }, "domains":[ "infobip.com" ], "tags":[ "Vip" ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] }, "examples":{ "Create company":{ "summary":"Create company", "value":"Infobipnotes exampleCroatiaEuropeJane SmithActiveIT0032120592018-06-01infobip.comVip" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] }, "examples":{ "Company response":{ "summary":"Company response", "value":{ "createdAt":"2017-12-01T19:16:41", "modifiedAt":"2017-12-01T19:16:41", "id":1, "name":"Infobip", "notes":"notes example", "country":"Croatia", "region":"Europe", "accountManager":"Jane Smith", "customerStage":"Active", "industry":"IT", "vatNumber":"003212059", "customAttributes":{ "Contract Expiry":"2018-06-01" }, "domains":[ "infobip.com" ], "tags":[ "Vip" ], "origin":"API", "modifiedFrom":"API" } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] }, "examples":{ "Company response":{ "summary":"Company response", "value":"2017-12-01T19:16:412017-12-01T19:16:411Infobipnotes exampleCroatiaEuropeJane SmithActiveIT0032120592018-06-01infobip.comVipAPIAPI" } } } } }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Delete a company", "description":"Use this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query.", "operationId":"delete-company", "parameters":[ { "name":"id", "in":"query", "description":"ID of company you want to delete.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int64" }, "example":"11351351" }, { "name":"externalId", "in":"query", "description":"External ID of company you want to delete.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"11351351" }, { "name":"name", "in":"query", "description":"Name of company you want to delete.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Infobip" }, { "name":"domain", "in":"query", "description":"Domain of company you want to delete.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"company-domain.com" } ], "responses":{ "200":{ "description":"successful response" }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Partial company update", "description":"Partial company update method is used for updating a part of the company information. Exactly one of the query parameters must be included in the query.", "operationId":"update-company", "parameters":[ { "name":"id", "in":"query", "description":"ID of company you want to update.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int64" }, "example":"11351351" }, { "name":"externalId", "in":"query", "description":"External ID of company you want to update.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"11351351" }, { "name":"name", "in":"query", "description":"Name of company you want to update.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Infobip" }, { "name":"domain", "in":"query", "description":"Domain of company you want to update.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"company-domain.com" }, { "name":"replaceTags", "in":"query", "description":"Flag which indicates tag replacement operation.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":"false" }, { "name":"replaceDomains", "in":"query", "description":"Flag which indicates domain replacement operation.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":"false" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] }, "examples":{ "setNewCustomerStageRequest":{ "summary":"Set the new customerStage for company", "value":{ "customerStage":"Testing" } } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] }, "examples":{ "Company response":{ "summary":"Company response", "value":{ "createdAt":"2017-12-01T19:16:41", "modifiedAt":"2017-12-01T19:16:41", "id":1, "name":"Infobip", "notes":"notes example", "country":"Croatia", "region":"Europe", "accountManager":"Jane Smith", "customerStage":"Active", "industry":"IT", "vatNumber":"003212059", "customAttributes":{ "Contract Expiry":"2018-06-01" }, "domains":[ "infobip.com" ], "tags":[ "Vip" ], "origin":"API", "modifiedFrom":"API" } }, "Response of set the new customerStage for company":{ "summary":"Response of set the new customerStage for company", "value":{ "createdAt":"2017-12-01T19:16:41", "modifiedAt":"2017-12-01T19:16:41", "id":1, "name":"Infobip", "notes":"notes example", "country":"Croatia", "region":"Europe", "accountManager":"Jane Smith", "customerStage":"Testing", "industry":"IT", "vatNumber":"003212059", "customAttributes":{ "Contract Expiry":"2018-06-01" }, "domains":[ "infobip.com" ], "tags":[ "Vip" ], "origin":"API", "modifiedFrom":"API" } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] }, "examples":{ "Company response":{ "summary":"Company response", "value":"2017-12-01T19:16:412017-12-01T19:16:411Infobipnotes exampleCroatiaEuropeJane SmithActiveIT0032120592018-06-01infobip.comVipAPIAPI" }, "Response of set the new customerStage for company":{ "summary":"Response of set the new customerStage for company", "value":"2017-12-01T19:16:412017-12-01T19:16:411Infobipnotes exampleCroatiaEuropeJane SmithTestingIT0032120592018-06-01infobip.comVipAPIAPI" } } } } }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/companies/batch":{ "post":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Batch companies create", "description":"Use this method to create multiple companies.
**NOTE** Array size of the batch create request is limited to `1000` companies.", "operationId":"create-companies", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateRequest" } ] }, "examples":{ "Batch companies create":{ "summary":"Batch companies create", "value":{ "companies":[ { "name":"Company name", "notes":"Some notes", "country":"Croatia", "segment":"Some segment", "accountManager":"Jane Smith", "customAttributes":{ "Contract Expiry":"2018-06-01" }, "domains":[ "domain.com" ] } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateRequest" } ] }, "examples":{ "Batch companies create":{ "summary":"Batch companies create", "value":"Company nameSome notesCroatiaSome segmentJane Smith2018-06-01domain.com" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse" } ] }, "examples":{ "Batch companies create":{ "summary":"Batch companies create", "value":{ "results":[ { "status":200, "id":1, "index":0 }, { "errors":[ { "message":"Key (lower(name::text))=(Company name) already exists." } ], "status":409, "index":1 } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse" } ] }, "examples":{ "Batch companies create":{ "summary":"Batch companies create", "value":"\n \n \n 200\n 1\n 0\n \n \n \n \n Key (lower(name::text))=(Company name) already exists.\n \n \n 409\n 1\n \n \n\n" } } } } }, "207":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse" } ] }, "examples":{ "Batch companies create":{ "summary":"Batch companies create", "value":{ "results":[ { "status":200, "id":1, "index":0 }, { "errors":[ { "message":"Key (lower(name::text))=(Company name) already exists." } ], "status":409, "index":1 } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse" } ] }, "examples":{ "Batch companies create":{ "summary":"Batch companies create", "value":"\n \n \n 200\n 1\n 0\n \n \n \n \n Key (lower(name::text))=(Company name) already exists.\n \n \n 409\n 1\n \n \n\n" } } } } }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Batch companies delete", "description":"Use this method to delete multiple companies.
**NOTE** Array size of the batch delete request is limited to `1000` companies.", "operationId":"delete-companies", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteRequest" } ] }, "examples":{ "Batch companies delete":{ "summary":"Batch companies delete", "value":{ "companies":[ { "query":{ "name":"Company name" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteRequest" } ] }, "examples":{ "Batch companies delete":{ "summary":"Batch companies delete", "value":"\n \n \n \n Company name\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse" } ] }, "examples":{ "Batch companies delete":{ "summary":"Batch companies delete", "value":{ "results":[ { "errors":[ { "message":"Company with name \"Company name\" does not exist" } ], "status":409, "query":{ "name":"Company name" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse" } ] }, "examples":{ "Batch companies delete":{ "summary":"Batch companies delete", "value":"\n \n \n \n \n Company with name \"Company name\" does not exist\n \n \n 409\n \n Company name\n \n \n \n\n" } } } } }, "207":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse" } ] }, "examples":{ "Batch companies delete":{ "summary":"Batch companies delete", "value":{ "results":[ { "errors":[ { "message":"Company with name \"Company name\" does not exist" } ], "status":409, "query":{ "name":"Company name" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse" } ] }, "examples":{ "Batch companies delete":{ "summary":"Batch companies delete", "value":"\n \n \n \n \n Company with name \"Company name\" does not exist\n \n \n 409\n \n Company name\n \n \n \n\n" } } } } }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Batch companies update", "description":"Use this method to update multiple companies.
**NOTE** Array size of the batch update request is limited to `1000` companies.", "operationId":"update-companies", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "type":"object", "properties":{ "companies":{ "type":"array", "description":"List of companies.", "items":{ "type":"object", "properties":{ "query":{ "allOf":[ { "$ref":"#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.CompanyIdentityQuery" } ] }, "update":{ "allOf":[ { "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" } ] } } } } }, "title":"Batch company update" } ] }, "examples":{ "batchCompanyUpdate":{ "summary":"batchCompanyUpdate", "value":{ "companies":[ { "query":{ "name":"Fancy company" }, "update":{ "segment":"First segment", "domains":[ "first-domain.com" ] } }, { "query":{ "id":"555" }, "update":{ "segment":"Second segment", "domains":[ "second-domain.com" ] } } ] } } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse" } ] }, "examples":{ "Batch companies update":{ "summary":"Batch companies update", "value":{ "results":[ { "errors":[ { "message":"Company with name \"Fancy company\" does not exist" } ], "status":409, "query":{ "name":"Fancy company" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse" } ] }, "examples":{ "Batch companies update":{ "summary":"Batch companies update", "value":"\n \n \n \n \n Company with name \"Fancy company\" does not exist\n \n \n 409\n \n Fancy company\n \n \n \n\n" } } } } }, "207":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse" } ] }, "examples":{ "Batch companies update":{ "summary":"Batch companies update", "value":{ "results":[ { "errors":[ { "message":"Company with name \"Fancy company\" does not exist" } ], "status":409, "query":{ "name":"Fancy company" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse" } ] }, "examples":{ "Batch companies update":{ "summary":"Batch companies update", "value":"\n \n \n \n \n Company with name \"Fancy company\" does not exist\n \n \n 409\n \n Fancy company\n \n \n \n\n" } } } } }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/companies/persons":{ "delete":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Remove persons from company batch", "description":"Use this method to remove persons from a company.
**NOTE** Array size is limited to `1000` persons.", "operationId":"batch-remove-persons-from-company", "parameters":[ { "name":"id", "in":"query", "description":"ID of company you want to remove persons from.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int64" }, "example":"11351351" }, { "name":"externalId", "in":"query", "description":"External ID of company you want to remove persons from.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"11351351" }, { "name":"name", "in":"query", "description":"Name of company you want to remove persons from.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Infobip" }, { "name":"domain", "in":"query", "description":"Domain of company you want to remove persons from.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"www.infobip.com" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest" } ] }, "examples":{ "Batch remove persons from company request":{ "summary":"Batch remove persons from company request", "value":{ "people":[ { "query":{ "type":"PHONE", "identifier":"41793026727" } }, { "query":{ "type":"EMAIL", "identifier":"johnwilliams@acme.com" } }, { "query":{ "type":"EXTERNAL_ID", "identifier":"123" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest" } ] }, "examples":{ "Batch remove persons from company request":{ "summary":"Batch remove persons from company request", "value":"\n \n \n \n PHONE\n 41793026727\n \n \n \n \n EMAIL\n johnwilliams@acme.com\n \n \n \n \n EXTERNAL_ID\n 123\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"successful response" }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "company-profile" ], "summary":"Add persons to company batch", "description":"Use this method to add persons to a company.
**NOTE** Array size is limited to `1000` persons.", "operationId":"batch-add-persons-to-company", "parameters":[ { "name":"id", "in":"query", "description":"ID of company you want to assign persons to.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int64" }, "example":"11351351" }, { "name":"externalId", "in":"query", "description":"External ID of company you want to assign persons to.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"11351351" }, { "name":"name", "in":"query", "description":"Name of company you want to assign persons to.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"Infobip" }, { "name":"domain", "in":"query", "description":"Domain of company you want to assign persons to.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" }, "example":"www.infobip.com" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest" } ] }, "examples":{ "Batch add persons to company request":{ "summary":"Batch add persons to company request", "value":{ "people":[ { "query":{ "type":"PHONE", "identifier":"41793026727" } }, { "query":{ "type":"EMAIL", "identifier":"johnwilliams@acme.com" } }, { "query":{ "type":"EXTERNAL_ID", "identifier":"123" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest" } ] }, "examples":{ "Batch add persons to company request":{ "summary":"Batch add persons to company request", "value":"\n \n \n \n PHONE\n 41793026727\n \n \n \n \n EMAIL\n johnwilliams@acme.com\n \n \n \n \n EXTERNAL_ID\n 123\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"successful response" }, "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-is-early-access":true, "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/tags":{ "get":{ "tags":[ "customer-engagement", "people", "tags" ], "summary":"Get list of tags", "description":"Use this method to get a list of tags with pagination.", "operationId":"get-list-of-tags", "parameters":[ { "name":"limit", "in":"query", "description":"Number of tags to return per page. Default - 20. Maximum - 1000.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":"100" }, { "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":"orderBy", "in":"query", "description":"Results ordering. Possible ordering fields are `name`, `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":"name:asc" }, { "name":"includeTotalCount", "in":"query", "description":"Returns total count of tags, if set to `true`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" }, "example":"false" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } }, "examples":{ "Tag response":{ "summary":"Tag response", "value":{ "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "id":123, "name":"Vip" } } } }, "application/xml":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } }, "examples":{ "Tag response":{ "summary":"Tag response", "value":"\n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n 123\n Vip\n\n" } } } } }, "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" } ] }, "post":{ "tags":[ "customer-engagement", "people", "tags" ], "summary":"Create a new tag", "description":"Use this method to create a new tag.", "operationId":"create-a-new-tag", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } ] }, "examples":{ "Create tag request":{ "summary":"Create tag request", "value":{ "name":"Vip" } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } ] }, "examples":{ "Create tag request":{ "summary":"Create tag request", "value":"\n Vip\n\n" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } ] }, "examples":{ "Tag response":{ "summary":"Tag response", "value":{ "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "id":123, "name":"Vip" } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } ] }, "examples":{ "Tag response":{ "summary":"Tag response", "value":"\n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n 123\n Vip\n\n" } } } } }, "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" } ] } }, "/people/2/tags/{name}":{ "get":{ "tags":[ "customer-engagement", "people", "tags" ], "summary":"Get a tag", "description":"Use this method to get a single tag.", "operationId":"get-a-tag", "parameters":[ { "name":"name", "in":"path", "description":"Name of the tag.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Vip" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } ] }, "examples":{ "Tag response":{ "summary":"Tag response", "value":{ "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "id":123, "name":"Vip" } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2" } ] }, "examples":{ "Tag response":{ "summary":"Tag response", "value":"\n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n 123\n Vip\n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "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" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "tags" ], "summary":"Delete a tag", "description":"Use this method to delete the existing tag.", "operationId":"delete-a-tag", "parameters":[ { "name":"name", "in":"path", "description":"Name of the tag.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Vip" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "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" } ] } }, "/people/2/tags/{name}/persons":{ "delete":{ "tags":[ "customer-engagement", "people", "tags" ], "summary":"Remove tag from people batch", "description":"This method allows you to remove tag from multiple people.
**NOTE** Array size of the batch remove request is limited to `1000` people.", "operationId":"remove-tag-from-people-batch", "parameters":[ { "name":"name", "in":"path", "description":"Name of the tag.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Vip" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest" } ] }, "examples":{ "Batch remove tag from persons request":{ "summary":"Batch remove tag from persons request", "value":{ "people":[ { "query":{ "type":"PHONE", "identifier":"41793026727" } }, { "query":{ "type":"EMAIL", "identifier":"johnwilliams@acme.com" } }, { "query":{ "type":"EXTERNAL_ID", "identifier":"123" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest" } ] }, "examples":{ "Batch remove tag from persons request":{ "summary":"Batch remove tag from persons request", "value":"\n \n \n \n PHONE\n 41793026727\n \n \n \n \n EMAIL\n johnwilliams@acme.com\n \n \n \n \n EXTERNAL_ID\n 123\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "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" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "tags" ], "summary":"Add tag to people batch", "description":"This method allows you to assign tag to multiple people.
**NOTE** Array size of the batch add request is limited to `1000` people.", "operationId":"add-tag-to-people-batch", "parameters":[ { "name":"name", "in":"path", "description":"Name of the tag.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Vip" } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest" } ] }, "examples":{ "Batch add tag to persons request":{ "summary":"Batch add tag to persons request", "value":{ "people":[ { "query":{ "type":"PHONE", "identifier":"41793026727" } }, { "query":{ "type":"EMAIL", "identifier":"johnwilliams@acme.com" } }, { "query":{ "type":"EXTERNAL_ID", "identifier":"123" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest" } ] }, "examples":{ "Batch add tag to persons request":{ "summary":"Batch add tag to persons request", "value":"\n \n \n \n PHONE\n 41793026727\n \n \n \n \n EMAIL\n johnwilliams@acme.com\n \n \n \n \n EXTERNAL_ID\n 123\n \n \n \n\n" } } } } }, "responses":{ "200":{ "description":"successful response" }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "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" } ] } }, "/people/2/customAttributes":{ "get":{ "tags":[ "customer-engagement", "people", "custom-attributes" ], "summary":"Get a list of custom attributes", "description":"Get a list of custom attributes using this method.", "operationId":"get-a-list-of-custom-attributes", "parameters":[ { "name":"limit", "in":"query", "description":"Number of custom attributes to return per page. Default - 20. Maximum - 1000.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32" }, "example":"100" }, { "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 custom attributes, 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 `name`, `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":"name:asc" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.CustomAttributesResponse" } ] }, "examples":{ "Response for get custom attributes request.":{ "summary":"Response for get custom attributes request.", "value":{ "limit":100, "page":1, "orderBy":"name:asc", "customAttributes":[ { "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "name":"Contract Expiry Date", "dataType":"DATE" }, { "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "name":"ShoppingCartList", "dataType":"LIST_OF_OBJECTS", "objectSchema":{ "productName":"STRING", "productPrice":"DECIMAL", "productCategory":"STRING", "productImage":"STRING" } } ] } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.CustomAttributesResponse" } ] }, "examples":{ "Response for get custom attributes request.":{ "summary":"Response for get custom attributes request.", "value":"\n 100\n 1\n name:asc\n \n \n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n Contract Expiry Date\n DATE\n \n \n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n ShoppingCartList\n LIST_OF_OBJECTS\n \n STRING\n DECIMAL\n STRING\n STRING\n \n \n \n\n" } } } } }, "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" } ] }, "post":{ "tags":[ "customer-engagement", "people", "custom-attributes" ], "summary":"Create a custom attribute", "description":"Create a new custom attribute by using this method.", "operationId":"create-a-custom-attribute", "requestBody":{ "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute" } ] }, "examples":{ "Create custom attribute.":{ "summary":"Create custom attribute.", "value":{ "name":"Contract Expiry Date", "dataType":"DATE" } }, "Create custom attribute with type \"LIST_OF_OBJECTS\".":{ "summary":"Create custom attribute with type \"LIST_OF_OBJECTS\".", "value":{ "name":"ShoppingCartList", "dataType":"LIST_OF_OBJECTS", "objectSchema":{ "productName":"STRING", "productPrice":"DECIMAL", "productCategory":"STRING", "productImage":"STRING" } } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute" } ] }, "examples":{ "Create custom attribute.":{ "summary":"Create custom attribute.", "value":"\n Contract Expiry Date\n DATE\n\n" }, "Create custom attribute with type \"LIST_OF_OBJECTS\".":{ "summary":"Create custom attribute with type \"LIST_OF_OBJECTS\".", "value":"\n ShoppingCartList\n LIST_OF_OBJECTS\n \n STRING\n DECIMAL\n STRING\n STRING\n \n\n" } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute" } ] }, "examples":{ "Response for create custom attribute request.":{ "summary":"Response for create custom attribute request.", "value":{ "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "name":"Contract Expiry Date", "dataType":"DATE" } }, "Response for create custom attribute with type \"LIST_OF_OBJECTS\" request.":{ "summary":"Response for create custom attribute with type \"LIST_OF_OBJECTS\" request.", "value":{ "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "name":"ShoppingCartList", "dataType":"LIST_OF_OBJECTS", "objectSchema":{ "productName":"STRING", "productPrice":"DECIMAL", "productCategory":"STRING", "productImage":"STRING" } } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute" } ] }, "examples":{ "Response for create custom attribute request.":{ "summary":"Response for create custom attribute request.", "value":"\n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n Contract Expiry Date\n DATE\n\n" }, "Response for create custom attribute with type \"LIST_OF_OBJECTS\" request.":{ "summary":"Response for create custom attribute with type \"LIST_OF_OBJECTS\" request.", "value":"\n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n ShoppingCartList\n LIST_OF_OBJECTS\n \n STRING\n DECIMAL\n STRING\n STRING\n \n\n" } } } } }, "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" } ] } }, "/people/2/customAttributes/{name}":{ "get":{ "tags":[ "customer-engagement", "people", "custom-attributes" ], "summary":"Get a single custom attribute", "description":"Get a single custom attribute using this method.", "operationId":"get-a-single-custom-attribute", "parameters":[ { "name":"name", "in":"path", "description":"Name of the attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Contract Expiry Date" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute" } ] }, "examples":{ "Response for get custom attribute request.":{ "summary":"Response for get custom attribute request.", "value":{ "createdAt":"2019-02-25T12:46:06", "modifiedAt":"2019-02-25T12:46:06", "name":"Contract Expiry Date", "dataType":"DATE" } } } }, "application/xml":{ "schema":{ "allOf":[ { "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute" } ] }, "examples":{ "Response for get custom attribute request.":{ "summary":"Response for get custom attribute request.", "value":"\n 2019-02-25T12:46:06\n 2019-02-25T12:46:06\n Contract Expiry Date\n DATE\n\n" } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "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" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "custom-attributes" ], "summary":"Delete a custom attribute", "description":"Use this method to delete the custom attribute", "operationId":"delete-a-custom-attribute", "parameters":[ { "name":"name", "in":"path", "description":"Name of the attribute you want to delete.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"Attribute" } ], "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "type":"string" } }, "application/xml":{ "schema":{ "type":"string" } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "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" } ] } }, "/people/2/customAttributes/{name}/append":{ "post":{ "tags":[ "customer-engagement", "people", "custom-attributes" ], "summary":"Append item to custom attribute", "description":"Custom attributes with `LIST_OF_OBJECTS` type contain an array of items as a value. Using this API method, you can add a new item to the specified list type custom attribute of a specific person. The item you want to add should match the defined list schema.", "operationId":"append-item-to-custom-attribute", "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":"name", "in":"path", "description":"Name of the list type custom attribute", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" }, "example":"ShoppingCartList" } ], "requestBody":{ "content":{ "application/json":{ "schema":{}, "examples":{ "appendItemToList":{ "summary":"Append new item to person's existing list", "description":"Add new item to the person’s existing list type custom attribute (e.g. “ShoppingCartList”).", "value":{ "productName":"Cap", "productPrice":11.33, "productCategory":"Hats", "productImage":"/image3.png" } } } } } }, "responses":{ "200":{ "description":"successful response", "content":{ "application/json":{ "schema":{ "type":"array", "items":{} }, "examples":{ "appendItemToList":{ "summary":"Append new item to person's existing list", "description":"Response when adding a new item to “ShoppingCartList” list type custom attribute (contains the whole person’s “ShoppingCartList” list, including appended item).", "value":[ { "productName":"Sneakers", "productPrice":25.33, "productCategory":"Sport Sneakers", "productImage":"/image1.png" }, { "productName":"T-Shirt", "productPrice":9.99, "productCategory":"Casual", "productImage":"/image2.png" }, { "productName":"Cap", "productPrice":11.33, "productCategory":"Hats", "productImage":"/image3.png" } ] } } } } }, "400":{ "$ref":"#/components/responses/ApiException400" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "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" } ] } }, "/people/3/lists/{listName}/items":{ "get":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Get items", "description":"Get a single item or a list of items of a list attribute.", "operationId":"get-list-items", "parameters":[ { "name":"listName", "in":"path", "description":"Name of the list attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } }, { "name":"itemIds", "in":"query", "description":"UUIDs of list items to return, separated by commas (,).", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"some value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "itemIds are not provided":{ "summary":"itemIds are not provided", "description":"itemIds are not provided", "value":{ "errorCode":400116, "message":"Missing parameter: itemIds" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } }, "list items with given name don't exist":{ "summary":"list items with given name don't exist", "description":"list items with given name don't exist", "value":{ "errorCode":300130, "message":"Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]" } }, "list items with given itemIds don't exist":{ "summary":"list items with given itemIds don't exist", "description":"list items with given itemIds don't exist", "value":{ "errorCode":300130, "message":"Items of list of object are not found [listName = my list, itemIds=[83a511bf-a478-4db2-be4f-e46cd187626d, 2a963012-dd58-414c-b751-32625ec6909]]" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Append items", "description":"Adds new items to a list attribute and returns all items of the updated list.", "operationId":"append-list-items", "parameters":[ { "name":"listName", "in":"path", "description":"Name of the list attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items to append.
Can't be less than 1 and more than 128 items.
Item IDs are not allowed." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "item_field_#1":"some value", "item_field_#2":42 } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"some value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for , value <1>, type , expected , but got " } }, "item ids shouldn't be passed":{ "summary":"item ids shouldn't be passed", "description":"item ids shouldn't be passed", "value":{ "errorCode":429002, "message":"Item ids shouldn't be passed" } }, "request body shouldn't be empty":{ "summary":"request body shouldn't be empty", "description":"request body shouldn't be empty", "value":{ "errorCode":400101, "message":"Validation errors: property items - size must be between 1 and 128" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Delete items", "description":"Deletes items in a list attribute and returns all items of the updated list.", "operationId":"delete-list-items", "parameters":[ { "name":"listName", "in":"path", "description":"Name of the list attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } }, { "name":"itemIds", "in":"query", "description":"UUIDs of list items to delete, separated by commas (,).", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf", "item_field_#1":"some value" }, { "__id":"844011e5-8c0d-4447-b67f-499bb9ff2783", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "itemIds are not provided":{ "summary":"itemIds are not provided", "description":"itemIds are not provided", "value":{ "errorCode":400116, "message":"Missing parameter: itemIds" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } }, "list items with given name don't exist":{ "summary":"list items with given name don't exist", "description":"list items with given name don't exist", "value":{ "errorCode":300130, "message":"Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/lists/{listName}/items/{itemId}":{ "put":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Replace an item", "description":"Replaces an item of a list attribute and returns all items of the updated list.", "operationId":"replace-list-item", "parameters":[ { "name":"listName", "in":"path", "description":"Name of the list attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemId", "in":"path", "description":"UUID of the list item to replace.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "description":"Item fields for replace.
Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "item_field_#1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new field value" } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "itemId isn't UUID":{ "summary":"itemId isn't UUID", "description":"itemId isn't UUID", "value":{ "errorCode":429002, "message":"Item id is invalid: 123456L" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for , value <1>, type , expected , but got " } }, "request body shouldn't be empty":{ "summary":"request body shouldn't be empty", "description":"request body shouldn't be empty", "value":{ "errorCode":400101, "message":"Validation errors: property items - size must be between 1 and 128" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Update an item", "description":"Updates the fields of a list item that are passed in the request.\nMissing fields will keep their values.\nReturns all items of the updated list attribute.", "operationId":"update-list-item", "parameters":[ { "name":"listName", "in":"path", "description":"Name of the list attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemId", "in":"path", "description":"UUID of the list item to update.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "description":"Item fields for update.
Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "item_field_#1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for , value <1>, type , expected , but got " } }, "request body shouldn't be empty":{ "summary":"request body shouldn't be empty", "description":"request body shouldn't be empty", "value":{ "errorCode":400101, "message":"Validation errors: property items - size must be between 1 and 128" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } }, "list items with given name don't exist":{ "summary":"list items with given name don't exist", "description":"list items with given name don't exist", "value":{ "errorCode":300130, "message":"Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/lists":{ "get":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Get lists", "description":"Returns all items of a single or multiple list attributes.", "operationId":"get-lists", "parameters":[ { "name":"listNames", "in":"query", "description":"Names of list attributes to return, separated by commas (,).", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } } ], "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "my list":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"some value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } }, "placeholders don't exist":{ "summary":"placeholders don't exist", "description":"placeholders don't exist", "value":{ "errorCode":300103, "message":"Placeholders with names [my list, my second list] do not exist" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Delete lists", "description":"Deletes a single or multiple list attributes of a profile.", "operationId":"delete-lists", "parameters":[ { "name":"listNames", "in":"query", "description":"Names of list attributes to delete, separated by commas (,).", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } } ], "responses":{ "204":{ "description":"Success" }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/lists/{listName}":{ "put":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Replace a list", "description":"Replaces all items in a list attribute and returns all items of the updated list.", "operationId":"replace-list", "parameters":[ { "name":"listName", "in":"path", "description":"Name of the list attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items data for replace.
Can't be less than 1 and more than 128 items.
Identifiers of items are not allowed in a body." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "item_field_#1":"some value", "item_field_#2":42 }, { "item_field_#1":"some value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"some value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"some value", "item_field_#2":42 } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "item ids shouldn't be passed":{ "summary":"item ids shouldn't be passed", "description":"item ids shouldn't be passed", "value":{ "errorCode":429002, "message":"Item ids shouldn't be passed" } }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for , value <1>, type , expected , but got " } }, "request body shouldn't be empty":{ "summary":"request body shouldn't be empty", "description":"request body shouldn't be empty", "value":{ "errorCode":400101, "message":"Validation errors: property items - size must be between 1 and 128" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Update a list", "description":"Updates the fields of list items passed in the request.\nMissing items and fields will keep their values.\nReturns all items of the updated list.", "operationId":"update-list", "parameters":[ { "name":"listName", "in":"path", "description":"Name of the list attribute.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Type of the person ID. Can be one of the above.", "required":true, "style":"form", "explode":true, "schema":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" } }, { "name":"identifier", "in":"query", "description":"Person ID. ID type must match the `type` parameter.", "required":true, "style":"form", "explode":true, "schema":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." } }, { "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", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items data for update.
Can't be less than 1 and more than 128 items.
New item IDs are not allowed.
Items without existing ids in are not allowed
If value of a field explicitly passed as NULL, it will delete a current value of the field." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new value", "item_field_#2":null }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"new value", "item_field_#2":42 } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Success", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "item_field_#1":"new value", "item_field_#3":"old value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "item_field_#1":"new value", "item_field_#2":42, "item_field_#3":"old value" } ] } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "examples":{ "identifier is not provided":{ "summary":"identifier is not provided", "description":"identifier is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: identifier" } }, "type is not provided":{ "summary":"type is not provided", "description":"type is not provided", "value":{ "errorCode":400116, "message":"Missing parameter: type" } }, "sender shouldn't be provided":{ "summary":"sender shouldn't be provided", "description":"sender shouldn't be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender shouldn't be specified" } }, "sender should be provided":{ "summary":"sender should be provided", "description":"sender should be provided", "value":{ "errorCode":400117, "message":"For type [TYPE] sender should be specified" } }, "item ids should be passed":{ "summary":"item ids should be passed", "description":"item ids should be passed", "value":"{\"errorCode\": 429002, \"message\": \"Ids should be presented for an every item: {\"item_field_#1\": \"new value\"}\"}" }, "incorrect field value is provided":{ "summary":"incorrect field value is provided", "description":"incorrect field value is provided", "value":{ "errorCode":300109, "message":"Invalid field value for , value <1>, type , expected , but got " } }, "request body shouldn't be empty":{ "summary":"request body shouldn't be empty", "description":"request body shouldn't be empty", "value":{ "errorCode":400101, "message":"Validation errors: property items - size must be between 1 and 128" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not found", "content":{ "application/json":{ "examples":{ "person doesn't exist":{ "summary":"person doesn't exist", "description":"person doesn't exist", "value":{ "errorCode":300101, "message":"Person with ID 'test@gmail.com' does not exist" } }, "placeholder doesn't exist":{ "summary":"placeholder doesn't exist", "description":"placeholder doesn't exist", "value":{ "errorCode":300103, "message":"Placeholder with name \"missing list\" does not exist" } }, "list items with given itemIds don't exist":{ "summary":"list items with given itemIds don't exist", "description":"list items with given itemIds don't exist", "value":{ "errorCode":300130, "message":"Items of list of objects are not found [listName = my list, itemIds=[b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f]]" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/persons/{personId}/lists/{listName}/items":{ "get":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Get items", "description":"Returns a single item or set of items of a list.", "operationId":"deprecated-get-list-items", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemIds", "in":"query", "description":"List of identifiers for items. Every identifier should be UUID.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } } ], "responses":{ "200":{ "description":"Item(s) found", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request: missing or invalid parameter", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attribute with a given listName
  • no instance of a list with a given listName
  • no items with given itemIds in a list
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:read", "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"get-list-items" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Append items", "description":"Adds new items to a list and returns all items of the updated list.", "operationId":"deprecated-append-list-items", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.
If an instance of a list doesn't exist for a person, the list instance will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items to append.
Can't be less than 1 and more than 128 items.
Item IDs are not allowed." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "field1":"field value" }, { "field1":"field value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Items appended", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
  • empty body
  • __id fields passed
  • fields undefined in the list schema passed
  • unexpected type of a field value passed
  • size of the resulting list exceeds 128 items
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attribute with a given list name
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"append-list-items" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Delete items", "description":"Deletes items with given identifiers and returns rest items of the updated list.", "operationId":"deprecated-delete-list-items", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemIds", "in":"query", "description":"List of identifiers for items. Every identifier should be UUID.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } } ], "responses":{ "200":{ "description":"Items deleted", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf", "field1":"field value" }, { "__id":"844011e5-8c0d-4447-b67f-499bb9ff2783", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request: missing or invalid parameter", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attribute with a given listName
  • no instance of a list with a given listName
  • no items with given itemIds in a list
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"delete-list-items" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/persons/{personId}/lists/{listName}/items/{itemId}":{ "put":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Replace an item", "description":"Replaces an item of a list and returns all items of the updated list.", "operationId":"deprecated-replace-list-item", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.
If an instance of a list doesn't exist for a person, the list instance will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemId", "in":"path", "description":"Identifier of an item to replace.
Identifier should be UUID.
Value of __id-field passed in a body will be replaced by the current value.
If an item with a given identifier doesn't exist, it will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "description":"Item fields for replace.
Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Item fields replaced", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
  • empty body
  • passed itemId can't be parsed as UUID
  • fields undefined in the list schema passed
  • unexpected type of a field value passed
  • size of the resulting list exceeds 128 items
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attribute with a given listName
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"replace-list-item" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Update an item", "description":"Updates only fields of the item that are presented in a given data.
Missing fields will be preserved.
Returns all items of the updated list.", "operationId":"deprecated-update-list-item", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"itemId", "in":"path", "description":"Identifier of an item to update.
Identifier should be UUID.
Value of __id-field passed in a body will be replaced by the current value.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "description":"Item fields for update.
Can't be less than 1 and more than 128 fields.
If value of a field explicitly passed as NULL, it will delete a current value of the field." }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" } } } } }, "required":true }, "responses":{ "200":{ "description":"Item fields updated", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value", "field2":"old field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value", "field2":"field value" } ] } } } } }, "400":{ "description":"Bad request:
  • empty body
  • passed itemId can't be parsed as UUID
  • fields undefined in the list schema passed
  • unexpected type of a field value passed
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attribute with a given listName
  • no instance of a list with a given listName
  • no items with a given itemId in a list
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"update-list-item" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/persons/{personId}/lists":{ "get":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Get lists", "description":"Returns all items of a single list or sets of items of a set of lists.", "operationId":"deprecated-get-lists", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listNames", "in":"query", "description":"Names given to lists.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } } ], "responses":{ "200":{ "description":"Lists found", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "list1":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ], "list2":[ { "__id":"1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf", "field1":"field value" }, { "__id":"844011e5-8c0d-4447-b67f-499bb9ff2783", "field1":"field value" } ] } } } } } }, "400":{ "description":"Bad request: missing or invalid parameter", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attributes with given listNames
  • no instances of list with given listNames
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:read", "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"get-lists" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Delete lists", "description":"Deletes a single list instance or set of lists instanses for a person.", "operationId":"deprecated-delete-lists", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64" } }, { "name":"listNames", "in":"query", "description":"Names given to lists.", "required":true, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string" } } } ], "responses":{ "204":{ "description":"Lists deleted" }, "400":{ "description":"Bad request: missing or invalid parameter", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attribute with a given listName
  • no instance of a list with a given listName
  • no items with given itemIds in a list
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"delete-lists" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/persons/{personId}/lists/{listName}":{ "put":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Replace a list", "description":"Replaces a list and returns all items of the updated list.", "operationId":"deprecated-replace-list", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.
If an instance of a list doesn't exist for a person, the list instance will be created.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items data for replace.
Can't be less than 1 and more than 128 items.
Identifiers of items are not allowed in a body." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "field1":"new field value" }, { "field1":"new field value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Items are replaced", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
  • empty body
  • __id fields passed
  • fields undefined in the list schema passed
  • unexpected type of a field value passed
  • size of the resulting list exceeds 128 items
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attributes with given listNames
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"replace-list" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "custom-attributes-lists" ], "summary":"Update a list", "description":"Updates only items and fields for a given data set.
Missing items and fields will be preserved.
Returns all items of the updated list.", "operationId":"deprecated-update-list", "parameters":[ { "name":"personId", "in":"path", "description":"Person's internal ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "minimum":1 } }, { "name":"listName", "in":"path", "description":"Name given to a list.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "type":"object", "description":"Items data for update.
Can't be less than 1 and more than 128 items.
New item IDs are not allowed.
Items without existing ids in are not allowed
If value of a field explicitly passed as NULL, it will delete a current value of the field." } }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"new field value" } ] } } } }, "required":true }, "responses":{ "200":{ "description":"Items updated", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":[ { "__id":"78f47a5a-b9c4-4802-8bed-e81cf5fde0b4", "field1":"new field value", "field2":"old field value" }, { "__id":"b606345f-f7a6-4b9d-b9f1-75bdeaf0e55f", "field1":"new field value", "field2":"old field value" }, { "__id":"1d543ae8-957d-4fe6-b0f4-ad3ce1eb5bbf", "field1":"field value" } ] } } } } }, "400":{ "description":"Bad request:
  • empty body
  • no __id fields passed
  • fields undefined in the list schema passed
  • unexpected type of a field value passed
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"
  • no profile with a given personId
  • no custom attribute with a given listName
  • no instance of a list with a given listName
  • no items with given itemIds in a list
", "content":{ "application/json":{ "examples":{ "Response example":{ "summary":"Response example", "value":{ "errorCode":0, "message":"string" } } } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "deprecated":true, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-is-early-access":"true", "x-scopes":[ "people:manage" ], "x-deprecationInformation":{ "deprecation":"2023-10-25T00:00:00.000+00:00", "sunset":"2024-01-25T00:00:00.000+00:00", "successorOperationId":"update-list" }, "x-throttling-info":[ { "type":"time", "numberOfRequests":3, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/contactInformation/push/{pushRegId}":{ "get":{ "tags":[ "customer-engagement", "people", "contact-information:-push" ], "summary":"Get push device registration", "description":"Use this method to get device data", "operationId":"get-push-device-registration", "parameters":[ { "name":"pushRegId", "in":"path", "description":"Registration identifier of a particular push device registration", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"AppCode", "in":"header", "description":"Application code", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "registrationId":"8621824C-86B2-41F7-BF6F-20D3B1426005", "applicationId":"753CBCDC1D587223934106E2A2AEDD44", "isPrimary":false, "systemData":{ "cloudType":"GCM", "registrationEnabled":true, "notificationsEnabled":true, "geofencingSdk":true, "sdkVersion":"2.0.9.1", "appVersion":"1.16.0", "os":"Android", "osVersion":"8.0.0", "deviceManufacturer":"HUAWEI", "deviceModel":"ANE-LX1", "deviceSecure":true, "osLanguage":"en", "deviceTimezoneOffset":"GMT+03:00", "deviceName":"ANE-LX1" } } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse" }, "examples":{ "You will get this error response if AppCode header is missing from the request":{ "summary":"You will get this error response if AppCode header is missing from the request", "description":"You will get this error response if AppCode header is missing from the request", "value":{ "errorCode":48001, "errorMessage":"Application code missing" } }, "Application with supplied application code does not exist":{ "summary":"Application with supplied application code does not exist", "description":"Application with supplied application code does not exist", "value":{ "errorCode":48012, "errorMessage":"Push application not found" } }, "Registration with supplied pushRegId does not exist":{ "summary":"Registration with supplied pushRegId does not exist", "description":"Registration with supplied pushRegId does not exist", "value":{ "errorCode":48013, "errorMessage":"Push registration not found" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:read", "mobile-app-messaging:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":50, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "patch":{ "tags":[ "customer-engagement", "people", "contact-information:-push" ], "summary":"Update push device registration", "description":"Use this method to update device data", "operationId":"update-push-device-registration", "parameters":[ { "name":"pushRegId", "in":"path", "description":"Registration identifier of a particular push device registration", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"AppCode", "in":"header", "description":"Application code", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Partial instance model", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance" }, "examples":{ "Change mutable standard properties and additional properties":{ "summary":"Change mutable standard properties and additional properties", "description":"Change mutable standard properties and additional properties", "value":{ "isPrimary":true, "systemData":{ "registrationEnabled":true }, "additionalData":{ "discountApplied":false } } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "registrationId":"8621824C-86B2-41F7-BF6F-20D3B1426005", "applicationId":"753CBCDC1D587223934106E2A2AEDD44", "isPrimary":false, "systemData":{ "cloudType":"GCM", "registrationEnabled":true, "notificationsEnabled":true, "geofencingSdk":true, "sdkVersion":"2.0.9.1", "appVersion":"1.16.0", "os":"Android", "osVersion":"8.0.0", "deviceManufacturer":"HUAWEI", "deviceModel":"ANE-LX1", "deviceSecure":true, "osLanguage":"en", "deviceTimezoneOffset":"GMT+03:00", "deviceName":"ANE-LX1" } } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse" }, "examples":{ "You will get this error response if AppCode header is missing from the request":{ "summary":"You will get this error response if AppCode header is missing from the request", "description":"You will get this error response if AppCode header is missing from the request", "value":{ "errorCode":48001, "errorMessage":"Application code missing" } }, "Application with supplied application code does not exist":{ "summary":"Application with supplied application code does not exist", "description":"Application with supplied application code does not exist", "value":{ "errorCode":48012, "errorMessage":"Push application not found" } }, "Registration with supplied pushRegId does not exist":{ "summary":"Registration with supplied pushRegId does not exist", "description":"Registration with supplied pushRegId does not exist", "value":{ "errorCode":48013, "errorMessage":"Push registration not found" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "mobile-app-messaging:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":50, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/contactInformation/push/{pushRegId}/depersonalize":{ "post":{ "tags":[ "customer-engagement", "people", "contact-information:-push" ], "summary":"Depersonalize push instance", "description":"You can depersonalize a device to detach it from a current person profile so that the device won’t receive messages when targeted by any of the person attributes", "operationId":"depersonalize-push-instance", "parameters":[ { "name":"pushRegId", "in":"path", "description":"Registration identifier of a particular push device registration", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"AppCode", "in":"header", "description":"Application code", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{} }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse" }, "examples":{ "You will get this error response if AppCode header is missing from the request":{ "summary":"You will get this error response if AppCode header is missing from the request", "description":"You will get this error response if AppCode header is missing from the request", "value":{ "errorCode":48001, "errorMessage":"Application code missing" } }, "Application with supplied application code does not exist":{ "summary":"Application with supplied application code does not exist", "description":"Application with supplied application code does not exist", "value":{ "errorCode":48012, "errorMessage":"Push application not found" } }, "Registration with supplied pushRegId does not exist":{ "summary":"Registration with supplied pushRegId does not exist", "description":"Registration with supplied pushRegId does not exist", "value":{ "errorCode":48013, "errorMessage":"Push registration not found" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "mobile-app-messaging:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":50, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/2/contactInformation/push/{pushRegId}/personalize":{ "post":{ "tags":[ "customer-engagement", "people", "contact-information:-push" ], "summary":"Personalize push instance", "description":"Each person can have Phone numbers, Emails or External ID. These fields are unique identifiers of a person on Infobip platform and provide a capability to personalize any push device registration with a person profile. The platform provides data grouping functions based on these parameters. For example, if two devices will try to save the same Phone number, then both of them will be collected under a single person. Phone number, Email and External ID are also widely used when targeting users with messages across different channels via Infobip platform.", "operationId":"personalize-push-instance", "parameters":[ { "name":"forceDepersonalize", "in":"query", "description":"You can set this parameter to true if you want previous personalization to be always reset. Do not use this parameter if you want to know when there’s an attempt to personalize already personalized registration.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"keepAsLead", "in":"query", "description":"You can set this parameter to true if you want to prevent the promotion from Lead to Customer. Only for specific use cases where the default behaviour wants to be avoided.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"returnPush", "in":"query", "description":"You can set this parameter to true if you want the response to include \"push\" mobile app contact information for the person.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"setDeviceAsPrimary", "in":"query", "description":"You can set this parameter to true if you want to set the device associated with the \"pushRegId\" as primary device for the person.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } }, { "name":"pushRegId", "in":"path", "description":"Registration identifier of a particular push device registration", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"AppCode", "in":"header", "description":"Application code", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Partial instance model", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationRequest" }, "examples":{ "Sample personalization request with tags and custom attributes update":{ "summary":"Sample personalization request with tags and custom attributes update", "description":"Sample personalization request with tags and custom attributes update", "value":{ "identity":{ "externalId":"external-user-id" }, "attributes":{ "tags":[ "Personalized" ], "customAttributes":{ "personalizationCompleted":true } } } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationResponse" }, "examples":{ "Sample personalization response":{ "summary":"Sample personalization response", "description":"Sample personalization response", "value":{ "externalId":"external-user-id", "customAttributes":{ "personalizationCompleted":true }, "tags":[ "Personalized" ], "contactInformation":{ "phones":[ { "number":"79810000000" } ], "emails":[ { "address":"my.email@gmail.com" } ] } } } } } } }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse" }, "examples":{ "You will get this error response if AppCode header is missing from the request":{ "summary":"You will get this error response if AppCode header is missing from the request", "description":"You will get this error response if AppCode header is missing from the request", "value":{ "errorCode":48001, "errorMessage":"Application code missing" } }, "Application with supplied application code does not exist":{ "summary":"Application with supplied application code does not exist", "description":"Application with supplied application code does not exist", "value":{ "errorCode":48012, "errorMessage":"Push application not found" } }, "Registration with supplied pushRegId does not exist":{ "summary":"Registration with supplied pushRegId does not exist", "description":"Registration with supplied pushRegId does not exist", "value":{ "errorCode":48013, "errorMessage":"Push registration not found" } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "mobile-app-messaging:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":50, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/events":{ "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Batch Send Events", "description":"Use this endpoint to batch import People events, including historical events that occurred up to `30` days ago. Batch items must reference an existing person profile and predefined [event type](https://portal.infobip.com/people/events/definitions). You can send up to `5000` events in a single batch. Each individual item within a batch must not exceed `512,000` bytes. The entire batch, which includes all items combined, must not exceed `15,728,640` bytes.
Each event in the batch must reference an existing person profile and a predefined event type. If an event references a person identifier that does not match any existing profile, a new `CUSTOMER` profile will automatically be created for that identifier.
**Note**: The entire batch will fail to import if any single event fails due to missing event type, properties, etc.", "operationId":"send-custom-events", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":[ { "definitionId":"addToCart", "occurredTime":"2025-03-17T13:00:27.864Z", "identifier":{ "id":"example@gmail.com", "type":"EMAIL", "sender":"75320" }, "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.413Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.413Z", "category":"shoes" } ] } }, { "definitionId":"addToCart", "occurredTime":"2025-03-17T11:30:00.109Z", "identifier":{ "id":"15", "type":"ID" }, "properties":{ "transactionId":"my-transaction-2", "fromPromoCampaign":false, "totalCost":1539, "itemsInCart":[ { "itemId":7, "price":39, "quantity":1, "inStockSince":"2024-09-21T10:12:50.209Z", "category":"shirt" }, { "itemId":8, "price":250, "quantity":6, "inStockSince":"2024-09-20T09:21:30.483Z", "category":"jacket" } ] } } ] } } } } }, "responses":{ "202":{ "description":"Accepted" }, "400":{ "description":"Bad request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse" }, "examples":{ "Invalid JSON request body":{ "summary":"Invalid JSON request body", "description":"Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400500, "message":"Invalid request. Please ensure the request body is a properly structured JSON array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid schema error":{ "summary":"Invalid schema error", "description":"Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.", "value":{ "errors":[ { "index":-1, "code":400501, "message":"The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: ." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Empty batch error":{ "summary":"Empty batch error", "description":"Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.", "value":{ "errors":[ { "index":-1, "code":400502, "message":"The batch cannot be empty. Please provide at least one item in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Batch count exceeded":{ "summary":"Batch count exceeded", "description":"Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400503, "message":"The batch count exceeds the allowed limit of items. Please reduce the number of items in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid batch item error":{ "summary":"Invalid batch item error", "description":"Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.", "value":{ "errors":[ { "index":0, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"eventId", "message":"Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-)." }, { "property":"identifier.id", "message":"Must not be empty." } ] }, { "index":4, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"identifier.type", "message":"Must be one of the following types: ." } ] } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Person not found error":{ "summary":"Person not found error", "description":"Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.", "value":{ "errors":[ { "index":0, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." }, { "index":4, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Internal event posting prohibition":{ "summary":"Internal event posting prohibition", "description":"Occurs when attempting to post an internal event.", "value":{ "errors":[ { "index":0, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." }, { "index":4, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } } } }, "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse" }, "examples":{ "Invalid JSON request body":{ "summary":"Invalid JSON request body", "description":"Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400500, "message":"Invalid request. Please ensure the request body is a properly structured JSON array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid schema error":{ "summary":"Invalid schema error", "description":"Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.", "value":{ "errors":[ { "index":-1, "code":400501, "message":"The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: ." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Empty batch error":{ "summary":"Empty batch error", "description":"Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.", "value":{ "errors":[ { "index":-1, "code":400502, "message":"The batch cannot be empty. Please provide at least one item in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Batch count exceeded":{ "summary":"Batch count exceeded", "description":"Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400503, "message":"The batch count exceeds the allowed limit of items. Please reduce the number of items in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid batch item error":{ "summary":"Invalid batch item error", "description":"Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.", "value":{ "errors":[ { "index":0, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"eventId", "message":"Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-)." }, { "property":"identifier.id", "message":"Must not be empty." } ] }, { "index":4, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"identifier.type", "message":"Must be one of the following types: ." } ] } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Person not found error":{ "summary":"Person not found error", "description":"Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.", "value":{ "errors":[ { "index":0, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." }, { "index":4, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Internal event posting prohibition":{ "summary":"Internal event posting prohibition", "description":"Occurs when attempting to post an internal event.", "value":{ "errors":[ { "index":0, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." }, { "index":4, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse" }, "examples":{ "Invalid JSON request body":{ "summary":"Invalid JSON request body", "description":"Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400500, "message":"Invalid request. Please ensure the request body is a properly structured JSON array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid schema error":{ "summary":"Invalid schema error", "description":"Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.", "value":{ "errors":[ { "index":-1, "code":400501, "message":"The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: ." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Empty batch error":{ "summary":"Empty batch error", "description":"Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.", "value":{ "errors":[ { "index":-1, "code":400502, "message":"The batch cannot be empty. Please provide at least one item in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Batch count exceeded":{ "summary":"Batch count exceeded", "description":"Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400503, "message":"The batch count exceeds the allowed limit of items. Please reduce the number of items in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid batch item error":{ "summary":"Invalid batch item error", "description":"Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.", "value":{ "errors":[ { "index":0, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"eventId", "message":"Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-)." }, { "property":"identifier.id", "message":"Must not be empty." } ] }, { "index":4, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"identifier.type", "message":"Must be one of the following types: ." } ] } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Person not found error":{ "summary":"Person not found error", "description":"Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.", "value":{ "errors":[ { "index":0, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." }, { "index":4, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Internal event posting prohibition":{ "summary":"Internal event posting prohibition", "description":"Occurs when attempting to post an internal event.", "value":{ "errors":[ { "index":0, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." }, { "index":4, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse" }, "examples":{ "Invalid JSON request body":{ "summary":"Invalid JSON request body", "description":"Occurs when the request body is either missing, null, or not properly structured as a JSON array, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400500, "message":"Invalid request. Please ensure the request body is a properly structured JSON array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid schema error":{ "summary":"Invalid schema error", "description":"Occurs when an event in the batch has a missing or incorrect schema definition. This can happen if the event's definition ID is not recognized, or if the properties do not match the expected schema, such as having redundant properties or incorrect types.", "value":{ "errors":[ { "index":-1, "code":400501, "message":"The event schema is invalid. Please ensure each event has a valid definition ID and properties match the expected schema. Details: ." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Empty batch error":{ "summary":"Empty batch error", "description":"Occurs when the request body contains an empty array for the batch, which is required to have at least one item for processing.", "value":{ "errors":[ { "index":-1, "code":400502, "message":"The batch cannot be empty. Please provide at least one item in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Batch count exceeded":{ "summary":"Batch count exceeded", "description":"Occurs when the number of items in the batch exceeds the maximum allowed limit, preventing successful processing of the request.", "value":{ "errors":[ { "index":-1, "code":400503, "message":"The batch count exceeds the allowed limit of items. Please reduce the number of items in the request array." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Invalid batch item error":{ "summary":"Invalid batch item error", "description":"Occurs when one or more properties of an event in the batch fail validation checks. This can include issues such as incorrect formats, values outside allowed ranges, or missing required properties.", "value":{ "errors":[ { "index":0, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"eventId", "message":"Must only include letters (A-Z, a-z), digits (0-9), underscores (_), and hyphens (-)." }, { "property":"identifier.id", "message":"Must not be empty." } ] }, { "index":4, "code":400504, "message":"One or more batch items contain invalid properties. Please review the details for specific validation errors.", "details":[ { "property":"identifier.type", "message":"Must be one of the following types: ." } ] } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Person not found error":{ "summary":"Person not found error", "description":"Occurs when the system is unable to locate a person using the provided identifier in the event. This prevents the event from being processed as the target person cannot be identified.", "value":{ "errors":[ { "index":0, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." }, { "index":4, "code":400505, "message":"Person with such identifier doesn't exist. Please verify the identifier and ensure it corresponds to an existing person in the system." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } }, "Internal event posting prohibition":{ "summary":"Internal event posting prohibition", "description":"Occurs when attempting to post an internal event.", "value":{ "errors":[ { "index":0, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." }, { "index":4, "code":400506, "message":"Internal events posting prohibited. Please ensure that only custom event definitions are used." } ], "traceId":"", "type":"https://tools.ietf.org/html/rfc9110#section-15.5.1", "title":"One or more validation errors occurred.", "status":400 } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:use" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/peopleevents/2/persons/{personId}/definitions/{definitionId}/events":{ "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Send Event", "description":"Use this endpoint to track events that persons perform. Your request must refer to existing person profile and [event definition](https://portal.infobip.com/people/events/definitions).", "operationId":"send-custom-event", "parameters":[ { "name":"definitionId", "in":"path", "description":"Identifier of the custom event definition. Event properties are passed in the request body.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"personId", "in":"path", "description":"Identifier of the person who performed the event. The `identifierType` query parameter specifies the type of the ID.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } }, { "name":"identifierType", "in":"query", "description":"Person's identifier type.", "required":true, "style":"form", "explode":true, "schema":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.PersonUniqueFieldType" } ] } }, { "name":"createPerson", "in":"query", "description":"Set this parameter to `true` to automatically create a person profile with the specified `personId` and `identifierType` if no existing profile matches the provided identifier. The default value is `false`.
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`.", "required":false, "style":"form", "explode":true, "schema":{ "type":"boolean" } } ], "requestBody":{ "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] } } } } } } }, "responses":{ "201":{ "description":"Successfully created", "content":{ "text/plain":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "eventId":"EFDB662A-F0BD-4064-8F49-16C0C1C48AD2", "definitionId":"addToCart", "occurredTime":"2024-05-17T15:47:50.4139152Z", "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] }, "metadata":{ "source":"API" } } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "eventId":"EFDB662A-F0BD-4064-8F49-16C0C1C48AD2", "definitionId":"addToCart", "occurredTime":"2024-05-17T15:47:50.4139152Z", "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] }, "metadata":{ "source":"API" } } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "eventId":"EFDB662A-F0BD-4064-8F49-16C0C1C48AD2", "definitionId":"addToCart", "occurredTime":"2024-05-17T15:47:50.4139152Z", "properties":{ "transactionId":"my-transaction-1", "fromPromoCampaign":true, "totalCost":100, "itemsInCart":[ { "itemId":1, "price":25, "quantity":3, "inStockSince":"2023-11-17T15:47:50.4136517Z", "category":"clothes" }, { "itemId":2, "price":25, "quantity":1, "inStockSince":"2023-12-17T15:47:50.4138054Z", "category":"shoes" } ] }, "metadata":{ "source":"API" } } } } } } }, "400":{ "description":"Invalid resource representation" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "$ref":"#/components/responses/ApiException404" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:use", "web:sdk" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":250, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/peopleevents/2/definitions":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"List Event Definitions", "description":"Retrieve a paginated list of event definitions, including standard, custom, and template definitions. Use query parameters to filter by category (`External`, `Person`, `Channel`, `Product`, `Template`) or search by definition ID, title, or description. Results can be ordered by definition ID or title.", "operationId":"list-event-definitions", "parameters":[ { "name":"offset", "in":"query", "description":"A pagination parameter that specifies the number of records to skip before starting to return results.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "maximum":2147483647, "minimum":0 } }, { "name":"limit", "in":"query", "description":"A pagination parameter that specifies the maximum number of records to return in a single response.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "format":"int32", "maximum":2147483647, "minimum":0 } }, { "name":"orderType", "in":"query", "description":"Defines the sort direction for the results.
**Note**: If `orderField` is not provided, this parameter will not have any effect.", "required":false, "style":"form", "explode":true, "schema":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderDirection" } ] } }, { "name":"orderField", "in":"query", "description":"Specifies the field by which the results should be ordered.
**Note**: If `orderType` is not provided, ordering will not work.", "required":false, "style":"form", "explode":true, "schema":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderField" } ] } }, { "name":"category", "in":"query", "description":"Filters results by one or more event definition categories.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory" } ] }, "uniqueItems":true } }, { "name":"searchText", "in":"query", "description":"Text used for searching event definitions by definition ID, title, or description.", "required":false, "style":"form", "explode":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" } }, "examples":{ "Response example":{ "summary":"Response example", "value":[ { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } ] } } }, "text/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" } }, "examples":{ "Response example":{ "summary":"Response example", "value":[ { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] }, { "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } ] } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"No matches" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:read" ] }, "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Create Event Definition", "description":"Create a new custom event definition either from scratch or from a template. When creating from scratch, specify a unique definition ID (alphanumeric only, max `36` characters), title, description, and up to `120` fields. When using a template, only provide the template ID and optional additional fields—the title, description, and default fields are inherited from the template. Supports various field types including `String`, `Boolean`, `DateTime`, `Numeric`, `Decimal`, and `List` (with nested object schema).", "operationId":"create-event-definition", "requestBody":{ "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } }, "required":true }, "responses":{ "201":{ "description":"Successfully created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } } }, "400":{ "description":"Invalid resource representation" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "409":{ "description":"Conflict. Definition with such 'definitionId' has already existed." }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ] } }, "/peopleevents/2/definitions/{definitionId}":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Get Event Definition", "description":"Retrieve complete details of a specific event definition, including its fields, data types, category, and whether it's a standard or custom definition. Useful for understanding the schema before sending events or for validating your event data structure.", "operationId":"get-event-definition", "parameters":[ { "name":"definitionId", "in":"path", "description":"Event definition identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"No matches" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage", "people:read" ] }, "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Update Event Definition", "description":"Update an existing custom event definition by adding new fields or modifying the title and description. Only supports additive changes—you can add new fields but **cannot** remove existing fields or change their types. This ensures backward compatibility with historical events. Standard (internal) definitions and template-inherited properties cannot be modified.", "operationId":"update-event-definition", "parameters":[ { "name":"definitionId", "in":"path", "description":"Event definition identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json-patch+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "application/*+json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource" }, "examples":{ "Request example":{ "summary":"Request example", "value":{ "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } }, "text/json":{ "schema":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource" }, "examples":{ "Response example":{ "summary":"Response example", "value":{ "isInternalDefinition":false, "category":"external", "definitionId":"addToCart", "title":"Item added to cart", "description":"Occurs when customer adds item to cart, without checkout. Carries information about items added", "fields":[ { "name":"transactionId", "type":"String" }, { "name":"fromPromoCampaign", "type":"Boolean" }, { "name":"totalCost", "type":"Decimal" }, { "name":"itemsInCart", "type":"List", "schema":{ "type":"Object", "fields":[ { "name":"itemId", "type":"Decimal" }, { "name":"price", "type":"Decimal" }, { "name":"quantity", "type":"Decimal" }, { "name":"inStockSince", "type":"DateTime" }, { "name":"category", "type":"String" } ] } } ] } } } } } }, "400":{ "description":"Invalid resource representation" }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"No matches" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "Basic":[] }, { "APIKeyHeader":[] }, { "IBSSOTokenHeader":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ] } }, "/peopleevents/1/export":{ "post":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Submit event export request", "description":"Events export allows you to asynchronously export People Events data to a compressed file or multiple files in your AWS S3 bucket.\n\nRefer to [product documentation](https://www.infobip.com/docs/people/events#events-in-external-systems) for detailed information on configuring AWS S3 for export, export file format and event data schema. \n\n**Throttling**\n\nYou can have maximum of 72 hours worth of export requests in progress at one time.\n\n", "operationId":"create-events-export-request", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a1a8ff0e2d4e8815c87f131be18d5198cdc635a778df6b963f0f0a4b59822f94.ExportRequestBody" }, "examples":{ "Export events to an s3 bucket":{ "summary":"Export events to an s3 bucket", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000" } }, "Export events to a directory of an s3 bucket":{ "summary":"Export events to a directory of an s3 bucket", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "directoryPath":"dir/subdir/", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000" } }, "Export events with definitionId matching filter":{ "summary":"Export events with definitionId matching filter", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000", "definitionIdList":[ "person*Flow", "emailOpened", "pageView" ] } }, "Export events enriched with moments information":{ "summary":"Export events enriched with moments information", "value":{ "roleArn":"arn:aws:iam::account:role/role-name-with-path", "bucket":"exported-events-bucket", "region":"EU_CENTRAL_1", "startTime":"2022-01-01T00:00:00.000+0000", "endTime":"2022-01-01T01:00:00.000+0000", "enrichWithMomentsInfo":true } } } } }, "required":true }, "responses":{ "202":{ "description":"Accepted", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.ExportResponseBody" }, "examples":{ "Response for a valid event export request":{ "summary":"Response for a valid event export request", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":5 } ] } }, "/peopleevents/1/export/status/{requestId}":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Check status of event export request", "description":"Retrieves the status of a previously submitted data export request by the request ID.", "operationId":"get-events-export-request-status", "parameters":[ { "name":"requestId", "in":"path", "description":"Request ID (unique identifier) of a previously submitted data export request.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "writeOnly":true } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.StatusResponseBody" }, "examples":{ "Request has been submitted but not processed.":{ "summary":"Request has been submitted but not processed.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"SUBMITTED" } }, "Request is in progress.":{ "summary":"Request is in progress.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"IN_PROGRESS" } }, "Request has been completed successfully.":{ "summary":"Request has been completed successfully.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"COMPLETED_SUCCESSFULLY" } }, "Request is completed with no events exported.":{ "summary":"Request is completed with no events exported.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"COMPLETED_SUCCESSFULLY", "message":"0 events found for the time period queried." } }, "There has been an error while processing the request, request is queued to be retried.":{ "summary":"There has been an error while processing the request, request is queued to be retried.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"FAILED_AWAITING_RETRY", "message":"Exception caught while trying to push file to S3." } }, "Request failed after maximum retries.":{ "summary":"Request failed after maximum retries.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"FAILED_AFTER_MAX_RETRIES", "message":"Exception caught while trying to push file to S3." } }, "Request is waiting to be cancelled.":{ "summary":"Request is waiting to be cancelled.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"SUBMITTED", "message":"Cancellation pending, cancellation request received at 2022-01-01T00:00:00.000Z" } }, "Request has been cancelled.":{ "summary":"Request has been cancelled.", "value":{ "requestId":"4c959f87-9a45-4e16-bcd2-7f2a79e95067", "status":"CANCELLED_BY_CUSTOMER", "message":"Cancellation complete, cancellation request received at 2022-01-01T00:00:00.000Z" } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":5 } ] } }, "/peopleevents/1/export/{requestId}":{ "delete":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Asynchronous cancellation of an event export request", "description":"Requests asynchronous cancellation of a previously submitted data export request by the request ID.", "operationId":"cancel-events-export-request", "parameters":[ { "name":"requestId", "in":"path", "description":"Request ID (unique identifier) of a previously submitted data export request.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"string", "writeOnly":true } } ], "responses":{ "202":{ "description":"Accepted", "content":{ "application/json":{} } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "409":{ "description":"Conflict", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":1 } ] } }, "/peopleevents/1/export/definitions":{ "get":{ "tags":[ "customer-engagement", "people", "events" ], "summary":"Get list of event definitions", "description":"Retrieves a list of all available event definitions, including custom events. \nThe event definitions can be then used as a filter in the \n[Event Export API](https://www.infobip.com/docs/api#customer-engagement/people/create-events-export-request).", "operationId":"get-events-definitions-for-export", "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.DefinitionsResponseBody" }, "examples":{ "Response for getting a list of `definitionId`s":{ "summary":"Response for getting a list of `definitionId`s", "value":{ "definitionIdList":[ "emailOpened", "pageView", "personEnteredFlow", "customEvent" ] } } } } } }, "400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" }, "examples":{ "Bad request":{ "summary":"Bad request", "value":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } } } } } }, "401":{ "$ref":"#/components/responses/ApiException401" }, "403":{ "$ref":"#/components/responses/ApiException403" }, "404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException" } } } }, "429":{ "$ref":"#/components/responses/ApiException429" }, "500":{ "$ref":"#/components/responses/ApiException500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"token", "replenishRate":1, "requestedTokens":1, "burstCapacity":5 } ] } }, "/people/3/segments":{ "get":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Get a list of segments", "description":"Use this method to get a list of segments.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"get-segments", "parameters":[ { "name":"page", "in":"query", "description":"Zero-based page index (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":0 } }, { "name":"size", "in":"query", "description":"The size of the page to be returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":20, "maximum":1000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string", "example":"name,DESC" } } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageSegmentResponseDto" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "post":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Create a segment", "description":"Use this method to create a segment.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"create-segment", "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentCreateDto" } } }, "required":true }, "responses":{ "201":{ "description":"Created", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/segments/{segmentId}":{ "get":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Get a segment", "description":"Use this method to get a segment by ID.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"get-segment", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":10, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "put":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Update a segment", "description":"Use this method to update a segment.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"update-segment", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentUpdateDto" } } }, "required":true }, "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto" } } } }, "400":{ "$ref":"#/components/responses/ApiError400" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] }, "delete":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Delete a segment", "description":"Use this method to delete a segment by ID.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"delete-segment", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 } ], "responses":{ "204":{ "description":"No Content" }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } }, "/people/3/segments/{segmentId}/persons":{ "get":{ "tags":[ "customer-engagement", "people", "segments" ], "summary":"Get persons in a segment", "description":"Use this method to get persons in a segment by ID.", "externalDocs":{ "description":"Learn more about Segments and its use cases.", "url":"https://www.infobip.com/docs/people/manage-audience#segments" }, "operationId":"get-segment-persons", "parameters":[ { "name":"segmentId", "in":"path", "description":"A unique segment identifier.", "required":true, "style":"simple", "explode":false, "schema":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "example":42 }, { "name":"page", "in":"query", "description":"Zero-based page index (0..N).", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":0 } }, { "name":"size", "in":"query", "description":"The size of the page to be returned.", "required":false, "style":"form", "explode":true, "schema":{ "type":"integer", "default":20, "maximum":1000, "minimum":1 } }, { "name":"sort", "in":"query", "description":"Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "required":false, "style":"form", "explode":true, "schema":{ "type":"array", "items":{ "type":"string", "example":"name,DESC" } } } ], "responses":{ "200":{ "description":"OK", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PagePersonV3" } } } }, "401":{ "$ref":"#/components/responses/ApiError401" }, "403":{ "$ref":"#/components/responses/ApiError403" }, "404":{ "$ref":"#/components/responses/ApiError404" }, "429":{ "$ref":"#/components/responses/ApiError429" }, "500":{ "$ref":"#/components/responses/ApiError500" } }, "security":[ { "IBSSOTokenHeader":[] }, { "APIKeyHeader":[] }, { "Basic":[] }, { "OAuth2":[] } ], "x-scopes":[ "people:read", "people:manage" ], "x-throttling-info":[ { "type":"time", "numberOfRequests":5, "numberOfTimeUnits":0, "timeUnit":"s" } ] } } }, "components":{ "schemas":{ "0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.CustomAttributesResponse":{ "type":"object", "properties":{ "customAttributes":{ "type":"array", "description":"List of custom attributes.", "items":{ "$ref":"#/components/schemas/0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute" }, "readOnly":false, "writeOnly":false }, "limit":{ "type":"integer", "format":"int32", "description":"Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows)", "readOnly":false, "writeOnly":false }, "orderBy":{ "type":"string", "description":"Results ordering", "readOnly":false, "writeOnly":false }, "page":{ "type":"integer", "format":"int32", "description":"Page number", "readOnly":false, "writeOnly":false }, "totalCount":{ "type":"integer", "format":"int64", "description":"Total amount of rows", "readOnly":true, "writeOnly":false } }, "title":"CustomAttributesResponse" }, "0797f98960a9d1f4df946ffe53c3c4e3e5cdc1dc56732cd123c79fa96c6ddca1.IamCustomAttribute":{ "type":"object", "properties":{ "createdAt":{ "type":"string", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "dataType":{ "allOf":[ { "$ref":"#/components/schemas/9a0795f64a40f2cbc302ee52c186009a1de422921e2055e9284671cdc2107f5b.IamAdditionalFieldDataType" } ], "description":"Custom attribute type.", "readOnly":false, "writeOnly":false }, "modifiedAt":{ "type":"string", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "name":{ "type":"string", "description":"Custom attribute name, 256 characters max. Invalid characters: `{}[]`.", "readOnly":false, "writeOnly":false }, "objectSchema":{ "type":"object", "additionalProperties":{ "allOf":[ { "$ref":"#/components/schemas/9a0795f64a40f2cbc302ee52c186009a1de422921e2055e9284671cdc2107f5b.IamAdditionalFieldDataType" } ] }, "description":"Object schema for `LIST_OF_OBJECTS` type. Defines the shape of the list items.", "readOnly":false, "writeOnly":false } }, "title":"IamCustomAttribute" }, "08ae7804593580772b7e2fc86ecf932ee109db81004beca72391a2ba65287a01.PersonDestinationRequest":{ "type":"object", "properties":{ "contactInformation":{ "allOf":[ { "$ref":"#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPersonContactsV2" } ], "description":"Person's contact information", "readOnly":false, "writeOnly":false } }, "required":[ "contactInformation" ], "title":"PersonDestinationRequest" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.CloudType":{ "type":"string", "description":"Push registration id of the instance", "enum":[ "GCM", "APNS", "HMS", "WEB" ], "readOnly":true, "title":"CloudType" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformation":{ "type":"object", "properties":{ "phones":{ "type":"array", "items":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationPhone" } }, "emails":{ "type":"array", "items":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationEmail" } }, "push":{ "type":"array", "items":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance" } } }, "title":"ContactInformation" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationEmail":{ "type":"object", "properties":{ "address":{ "type":"string" } }, "title":"ContactInformationEmail" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationPhone":{ "type":"object", "properties":{ "number":{ "type":"string" } }, "title":"ContactInformationPhone" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.OperatingSystem":{ "type":"string", "description":"Operating system type can be `Android` or `iOS`", "enum":[ "Android", "iOS" ], "readOnly":true, "title":"OperatingSystem" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse":{ "type":"object", "properties":{ "errorCode":{ "type":"integer", "format":"int32" }, "errorMessage":{ "type":"string" } }, "required":[ "errorCode", "errorMessage" ], "title":"PushApiErrorResponse" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiGender":{ "type":"string", "description":"User gender", "enum":[ "MALE", "FEMALE" ], "title":"PushApiGender" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstance":{ "type":"object", "properties":{ "registrationId":{ "type":"string", "description":"Push registration id of the instance", "readOnly":true }, "applicationId":{ "type":"string", "description":"String id of the application that the instance belongs to", "readOnly":true }, "isPrimary":{ "type":"boolean", "description":"Set to `true` if this device is a primary device of a user among other devices" }, "additionalData":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Custom attributes set for a device" }, "systemData":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstanceSystemData" } }, "required":[ "applicationId", "registrationId" ], "title":"PushApiInstance" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiInstanceSystemData":{ "type":"object", "description":"Set of push-specific attributes", "properties":{ "cloudType":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.CloudType" }, "registrationEnabled":{ "type":"boolean", "description":"State of the device registration" }, "notificationsEnabled":{ "type":"boolean", "description":"Set to `true` if notifications are enabled on a device", "readOnly":true }, "geofencingSdk":{ "type":"boolean", "deprecated":true, "description":"Set to `true` if geo fencing is enabled on a device. **Deprecated: This property is no longer in use since iOS SDK version 12.19.0 and Android SDK version 13.0.3.**", "readOnly":true }, "sdkVersion":{ "type":"string", "description":"SDK version that is running on a device", "readOnly":true }, "appVersion":{ "type":"string", "description":"The version of the application which SDK is embedded into", "readOnly":true }, "os":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.OperatingSystem" }, "osVersion":{ "type":"string", "description":"The version of the operating system", "readOnly":true }, "deviceManufacturer":{ "type":"string", "description":"The manufacturer of the device as detected by the SDK", "readOnly":true }, "deviceModel":{ "type":"string", "description":"The model of the device", "readOnly":true }, "deviceSecure":{ "type":"boolean", "description":"Set to `true` if the device has any type of secure screen lock set up", "readOnly":true }, "osLanguage":{ "type":"string", "description":"An identifier of the language used on a device", "readOnly":true }, "deviceTimezoneOffset":{ "type":"string", "description":"UTC-related timezone offset that identifies a current timezone of a device", "readOnly":true }, "deviceName":{ "type":"string", "description":"The name of the device as configured by a user", "readOnly":true } }, "title":"PushApiInstanceSystemData" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserIdentity":{ "type":"object", "description":"Unique identifiers from this object will be used to find a person to personalize push registration with", "properties":{ "externalId":{ "type":"string", "description":"Id of a user in external system. **Notice**: for `externalId` any string values such as `\"null\"`, `\"Null\"` or `\"NULL\"` are not supported and would be considered as JSON `null`" }, "email":{ "type":"string", "description":"User email" }, "phoneNumber":{ "type":"string", "description":"User phone number according to E.164 general format" } }, "title":"PushUserIdentity" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationRequest":{ "type":"object", "properties":{ "identity":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserIdentity" }, "attributes":{ "type":"object", "description":"Data specified in this object will be applied to the target person upon personalization", "properties":{ "firstName":{ "type":"string", "description":"User first name" }, "lastName":{ "type":"string", "description":"User last name" }, "middleName":{ "type":"string", "description":"User middle name" }, "birthday":{ "type":"string", "format":"date-time" }, "gender":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiGender" }, "customAttributes":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Set of custom key-value pairs where value can be any of `string`, `number`, `boolean`" }, "tags":{ "type":"array", "description":"Set of string labels attached to the user", "items":{ "type":"string", "description":"Set of string labels attached to the user" }, "uniqueItems":true } } } }, "required":[ "identity" ], "title":"PushUserPersonalizationRequest" }, "0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushUserPersonalizationResponse":{ "type":"object", "properties":{ "externalId":{ "type":"string", "description":"Id of a user in external system" }, "firstName":{ "type":"string", "description":"User first name" }, "lastName":{ "type":"string", "description":"User last name" }, "middleName":{ "type":"string", "description":"User middle name" }, "birthday":{ "type":"string", "format":"date-time" }, "gender":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiGender" }, "customAttributes":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Set of custom key-value pairs where value can be any of `string`, `number`, `boolean`" }, "tags":{ "type":"array", "description":"Set of string labels attached to the user", "items":{ "type":"string", "description":"Set of string labels attached to the user" }, "uniqueItems":true }, "contactInformation":{ "$ref":"#/components/schemas/0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformation" } }, "title":"PushUserPersonalizationResponse" }, "2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.", "items":{ "$ref":"#/components/schemas/2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResult" }, "readOnly":false, "writeOnly":false } }, "title":"BatchUpdateResponse" }, "2a46bdef7a59052adf56f3586860f3d5ab1636f1aff3d3f91907d1203b8dad63.BatchUpdateResult":{ "type":"object", "properties":{ "errors":{ "type":"array", "description":"List of errors", "items":{ "$ref":"#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError" }, "readOnly":false, "writeOnly":false }, "isModified":{ "type":"boolean" }, "query":{ "allOf":[ { "$ref":"#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery" } ] }, "status":{ "type":"integer", "format":"int32", "description":"HTTP status", "readOnly":false, "writeOnly":false } }, "title":"BatchUpdateResult" }, "3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError":{ "type":"object", "properties":{ "message":{ "type":"string", "description":"Error message", "readOnly":false, "writeOnly":false } }, "title":"BatchOperationError" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ByUniqueRequestParameters":{ "type":"object", "description":"List of identities.", "properties":{ "type":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" }, "identifier":{ "type":"string", "description":"Person ID. ID type must match the `type` parameter." }, "sender":{ "type":"string", "description":"Sender or application ID.`sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`" } }, "required":[ "identifier", "type" ], "title":"ByUniqueRequestParameters" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3":{ "type":"string", "description":"Type of the person ID.", "enum":[ "PHONE", "EMAIL", "FACEBOOK", "LINE", "TELEGRAM", "PUSH", "WEB_PUSH", "LIVE_CHAT", "VIBER_BOTS", "INSTAGRAM", "TWITTER", "INSTAGRAM_DM", "KAKAO_SANGDAM", "APPLE_BUSINESS_CHAT", "OPEN_CHANNEL", "ZALO_FOLLOWER", "TIKTOK_BM", "WHATSAPP", "KAKAO_TALK" ], "example":"PHONE", "title":"ContactInformationTypeV3" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3Upsert":{ "type":"string", "description":"Type of the person ID.", "enum":[ "PHONE", "EMAIL" ], "example":"PHONE", "title":"ContactInformationTypeV3Upsert" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorCodeV3":{ "type":"string", "description":"Error code identifying the type of error that occurred.", "enum":[ "400100", "400101", "400102", "400103", "400104", "400105", "400106", "400107", "404100", "404101", "405100", "409100", "500100" ], "title":"ErrorCodeV3" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorDetail":{ "type":"object", "description":"Detailed error information for a specific property or field.", "properties":{ "property":{ "type":"string", "description":"Name of the property or field that caused the validation error." }, "message":{ "type":"string", "description":"Specific error message describing the validation failure." }, "payload":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Additional context or metadata related to the validation error." } }, "title":"ErrorDetail" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorResponseV3":{ "type":"object", "description":"Error information for failed batch operation items.", "properties":{ "code":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorCodeV3" }, "message":{ "type":"string", "description":"Human-readable error message describing what went wrong." }, "details":{ "type":"array", "description":"Additional validation error details with specific property-level information.", "items":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ErrorDetail" } }, "index":{ "type":"integer", "format":"int32", "description":"Index position of the failed item in the original request batch." } }, "title":"ErrorResponseV3" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchAmgModel":{ "type":"object", "description":"List of matches.", "properties":{ "personId":{ "type":"integer", "format":"int64", "description":"Person's internal ID." }, "type":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType" }, "identifier":{ "type":"string", "description":"Person ID" }, "sender":{ "type":"string", "description":"Sender or application ID." } }, "title":"MatchAmgModel" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchRequest":{ "type":"object", "properties":{ "identities":{ "type":"array", "description":"List of identities.", "items":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ByUniqueRequestParameters" } } }, "required":[ "identities" ], "title":"MatchRequest" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchResponse":{ "type":"object", "properties":{ "matches":{ "type":"array", "description":"List of matches.", "items":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MatchAmgModel" } } }, "title":"MatchResponse" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeContactInformationV3DocsSchema":{ "type":"object", "description":"List of phones, emails and other information how a person can be contacted.", "properties":{ "type":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3" }, "identifier":{ "type":"string", "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. 255 characters max.", "example":"41793026727", "maxLength":255, "minLength":0 }, "sender":{ "type":"string", "description":"Sender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max.", "example":"41793026728", "maxLength":255, "minLength":0 }, "primary":{ "type":"boolean", "description":"Indicates if this ID is preferred for communication. This flag only applies to PHONE and EMAIL.", "example":true } }, "title":"MergeContactInformationV3DocsSchema" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergePersonV3DocsSchema":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Unique id of the entity.", "example":1, "readOnly":true }, "externalId":{ "type":"string", "description":"Unique ID for a person from your or another external system, 256 characters max.", "example":"3", "maxLength":256, "minLength":0 }, "type":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonTypeV3" }, "firstName":{ "type":"string", "description":"Person's first name, 255 characters max.", "example":"Jane", "maxLength":255, "minLength":0 }, "middleName":{ "type":"string", "description":"Person's middle name, 50 characters max.", "example":"Janie", "maxLength":50, "minLength":0 }, "lastName":{ "type":"string", "description":"Person's last name, 255 characters max.", "example":"Smith", "maxLength":255, "minLength":0 }, "nickName":{ "type":"string", "description":"Person's nick name, 50 characters max.", "example":"Janey", "maxLength":50, "minLength":0 }, "country":{ "type":"string", "description":"Person's country, 50 characters max.", "example":"United Kingdom", "maxLength":50, "minLength":0 }, "city":{ "type":"string", "description":"Person's city, 50 characters max.", "example":"London", "maxLength":50, "minLength":0 }, "address":{ "type":"string", "description":"Person's address, 256 characters max.", "example":"67 Farringdon Road", "maxLength":256, "minLength":0 }, "gender":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonGenderV3" }, "preferredLanguage":{ "type":"string", "description":"Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.", "example":"en-gb" }, "birthDate":{ "type":"string", "format":"date", "description":"Person's date of birth, format `YYYY-MM-DD`.", "example":"1966-01-15" }, "profilePicture":{ "type":"string", "format":"url", "description":"URL for the person's profile picture, 2083 characters max.", "example":"http://profile.com", "maxLength":2083, "minLength":0 }, "tags":{ "type":"array", "description":"List of tags that this person has.", "example":[ "tag1", "tag2" ], "items":{ "type":"string", "description":"List of tags that this person has.", "example":"[\"tag1\",\"tag2\"]" }, "uniqueItems":true }, "contactInformation":{ "type":"array", "description":"List of phones, emails and other information how a person can be contacted.", "items":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeContactInformationV3DocsSchema" } }, "customAttributes":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "Contract Expiry":"2024-06-12", "Company":"ACME" } }, "description":"List of custom attributes for the person, 4096 characters max per value.", "example":{ "Contract Expiry":"2024-06-12", "Company":"ACME" } }, "computedAttributes":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "fullName":"Jane Smith" }, "readOnly":true }, "description":"Person's computed attributes grouped by type.", "example":{ "fullName":"Jane Smith" }, "readOnly":true }, "createdFrom":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3" }, "createdBy":{ "type":"string", "description":"Identifier of the user who created this person record.", "example":"5", "readOnly":true }, "createdAt":{ "type":"string", "format":"date-time", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true }, "modifiedFrom":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3" }, "modifiedBy":{ "type":"string", "description":"Identifier of the user who last modified this person record.", "example":"5", "readOnly":true }, "modifiedAt":{ "type":"string", "format":"date-time", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true } }, "title":"MergePersonV3DocsSchema" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeRequestDocsSchema":{ "type":"object", "properties":{ "persons":{ "type":"array", "items":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergePersonV3DocsSchema" }, "maxItems":1000, "minItems":1 } }, "title":"MergeRequestDocsSchema" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.MergeSuccessResult":{ "type":"object", "description":"Successful result for a person merge operation.", "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Unique identifier of the merged person profile." }, "index":{ "type":"integer", "format":"int32", "description":"Index position of this person in the original request batch." } }, "title":"MergeSuccessResult" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3":{ "type":"string", "description":"Source system that last modified this person record.", "enum":[ "API", "PORTAL", "WEB_SDK", "INTEGRATION", "PUSH", "FACEBOOK", "LINE", "TELEGRAM", "SALESFORCE", "DYNAMICS", "ZAPIER", "FORMS", "AMS", "COMPUTED", "ANSWERS", "CONVERSATIONS", "IMPORT", "INSTAGRAM_DM", "FLOW", "LIVE_CHAT", "VKONTAKTE", "ZALO_FOLLOWER", "TIKTOK_BM", "WHATSAPP", "KAKAO_TALK", "UNKNOWN" ], "example":"API", "readOnly":true, "title":"OriginV3" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonGenderV3":{ "type":"string", "description":"Person's gender.", "enum":[ "MALE", "FEMALE" ], "example":"FEMALE", "title":"PersonGenderV3" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonTypeV3":{ "type":"string", "description":"Person's type, default type is CUSTOMER.", "enum":[ "CUSTOMER", "LEAD" ], "example":"CUSTOMER", "title":"PersonTypeV3" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonUniqueFieldType":{ "type":"string", "description":"Type of the person ID. Can be one of the above.", "enum":[ "ID", "EXTERNAL_ID", "PHONE", "EMAIL", "LINE", "FACEBOOK", "TELEGRAM", "PUSH", "LIVE_CHAT", "VIBER_BOTS", "INSTAGRAM", "INSTAGRAM_DM", "TWITTER", "APPLE_BUSINESS_CHAT", "KAKAO_SANGDAM", "OPEN_CHANNEL", "ZALO_FOLLOWER", "TIKTOK_BM", "WHATSAPP", "KAKAO_TALK" ], "title":"PersonUniqueFieldType" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertContactInformationV3DocsSchema":{ "type":"object", "description":"List of phones, emails and other information how a person can be contacted.", "properties":{ "type":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.ContactInformationTypeV3Upsert" }, "identifier":{ "type":"string", "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. 255 characters max.", "example":"41793026727", "maxLength":255, "minLength":0 }, "sender":{ "type":"string", "description":"Sender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max.", "example":"41793026728", "maxLength":255, "minLength":0 }, "primary":{ "type":"boolean", "description":"Indicates if this ID is preferred for communication.", "example":true } }, "title":"UpsertContactInformationV3DocsSchema" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertOperationStatusV3":{ "type":"string", "description":"Status indicating the type of operation performed on a person profile during upsert", "enum":[ "CREATED", "UPDATED", "NOT_MODIFIED" ], "title":"UpsertOperationStatusV3" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertPersonV3DocsSchema":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Unique id of the entity.", "example":1, "readOnly":true }, "externalId":{ "type":"string", "description":"Unique ID for a person from your or another external system, 256 characters max.", "example":"3", "maxLength":256, "minLength":0 }, "type":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonTypeV3" }, "firstName":{ "type":"string", "description":"Person's first name, 255 characters max.", "example":"Jane", "maxLength":255, "minLength":0 }, "middleName":{ "type":"string", "description":"Person's middle name, 50 characters max.", "example":"Janie", "maxLength":50, "minLength":0 }, "lastName":{ "type":"string", "description":"Person's last name, 255 characters max.", "example":"Smith", "maxLength":255, "minLength":0 }, "nickName":{ "type":"string", "description":"Person's nick name, 50 characters max.", "example":"Janey", "maxLength":50, "minLength":0 }, "country":{ "type":"string", "description":"Person's country, 50 characters max.", "example":"United Kingdom", "maxLength":50, "minLength":0 }, "city":{ "type":"string", "description":"Person's city, 50 characters max.", "example":"London", "maxLength":50, "minLength":0 }, "address":{ "type":"string", "description":"Person's address, 256 characters max.", "example":"67 Farringdon Road", "maxLength":256, "minLength":0 }, "gender":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.PersonGenderV3" }, "preferredLanguage":{ "type":"string", "description":"Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.", "example":"en-gb" }, "birthDate":{ "type":"string", "format":"date", "description":"Person's date of birth, format `YYYY-MM-DD`.", "example":"1966-01-15" }, "profilePicture":{ "type":"string", "format":"url", "description":"URL for the person's profile picture, 2083 characters max.", "example":"http://profile.com", "maxLength":2083, "minLength":0 }, "tags":{ "type":"array", "description":"List of tags that this person has.", "example":[ "tag1", "tag2" ], "items":{ "type":"string", "description":"List of tags that this person has.", "example":"[\"tag1\",\"tag2\"]" }, "uniqueItems":true }, "contactInformation":{ "type":"array", "description":"List of phones, emails and other information how a person can be contacted.", "items":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertContactInformationV3DocsSchema" } }, "customAttributes":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "Contract Expiry":"2024-06-12", "Company":"ACME" } }, "description":"List of custom attributes for the person, 4096 characters max per value.", "example":{ "Contract Expiry":"2024-06-12", "Company":"ACME" } }, "computedAttributes":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "fullName":"Jane Smith" }, "readOnly":true }, "description":"Person's computed attributes grouped by type.", "example":{ "fullName":"Jane Smith" }, "readOnly":true }, "createdFrom":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3" }, "createdBy":{ "type":"string", "description":"Identifier of the user who created this person record.", "example":"5", "readOnly":true }, "createdAt":{ "type":"string", "format":"date-time", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true }, "modifiedFrom":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.OriginV3" }, "modifiedBy":{ "type":"string", "description":"Identifier of the user who last modified this person record.", "example":"5", "readOnly":true }, "modifiedAt":{ "type":"string", "format":"date-time", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true } }, "title":"UpsertPersonV3DocsSchema" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertRequestDocsSchema":{ "type":"object", "properties":{ "persons":{ "type":"array", "items":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertPersonV3DocsSchema" }, "maxItems":1000, "minItems":1 } }, "title":"UpsertRequestDocsSchema" }, "41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertSuccessResult":{ "type":"object", "description":"Successful result for a person upsert operation.", "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Unique identifier of the upserted person profile." }, "index":{ "type":"integer", "format":"int32", "description":"Index position of this person in the original request batch." }, "status":{ "$ref":"#/components/schemas/41037c0c5bdf4509c49aaf5c9a141a8857afc7b3859839aa4c690d84fb75d2e2.UpsertOperationStatusV3" } }, "title":"UpsertSuccessResult" }, "4d8013f567a19c1659f9fa9ee91385e2997d2edc529631040fb843879960b1b6.ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamEmailContactV2":{ "type":"object", "properties":{ "address":{ "type":"string", "description":"Person's email address. Must comply with the [email format](https://tools.ietf.org/html/rfc2822) and cannot exceed 255 characters. One person can have up to 100 email addresses.", "readOnly":false, "writeOnly":false } }, "title":"IamEmailContactV2" }, "61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPersonContactsV2":{ "type":"object", "properties":{ "appleBusinessChat":{ "type":"array", "description":"A list of person's Apple Business Chat destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "email":{ "type":"array", "description":"A list of person's email addresses. Max 100 emails per person.", "items":{ "$ref":"#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamEmailContactV2" }, "readOnly":false, "writeOnly":false }, "facebook":{ "type":"array", "description":"A list of person's Messenger destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "instagram":{ "type":"array", "description":"A list of person's Instagram destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "instagramDm":{ "type":"array", "description":"A list of person's Instagram DM destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "kakaoSangdam":{ "type":"array", "description":"A list of person's Kakao Sangdam destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "line":{ "type":"array", "description":"A list of person's Line destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "liveChat":{ "type":"array", "description":"A list of person's Live Chat destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "openChannel":{ "type":"array", "description":"A list of person's Open Channel destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "phone":{ "type":"array", "description":"A list of person's phone numbers. Max 100 numbers per person.", "items":{ "$ref":"#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPhoneContactV2" }, "readOnly":false, "writeOnly":false }, "push":{ "type":"array", "description":"List of person's push registrations.", "items":{ "$ref":"#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPushContactV2" }, "readOnly":true, "writeOnly":false }, "telegram":{ "type":"array", "description":"A list of person's Telegram destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "tiktokBm":{ "type":"array", "description":"A list of person's TikTok Business Messaging destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "twitter":{ "type":"array", "description":"A list of person's Twitter destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "viberBots":{ "type":"array", "description":"A list of person's Viber Bots destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "webpush":{ "type":"array", "description":"A list of person's web push registrations", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonPushContact" }, "readOnly":true, "writeOnly":false }, "whatsapp":{ "type":"array", "description":"A list of person's WhatsApp destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false }, "zaloFollower":{ "type":"array", "description":"A list of person's Zalo Follower destinations.", "items":{ "$ref":"#/components/schemas/b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact" }, "readOnly":true, "writeOnly":false } }, "title":"IamPersonContactsV2" }, "61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPhoneContactV2":{ "type":"object", "properties":{ "number":{ "type":"string", "description":"Person's phone number. Must be in [international format](https://en.wikipedia.org/wiki/E.164) and cannot exceed 50 characters. One person can have up to 100 phone numbers.", "readOnly":false, "writeOnly":false } }, "title":"IamPhoneContactV2" }, "61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPushContactV2":{ "type":"object", "properties":{ "additionalData":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Additional data collected from the user's profile", "readOnly":true, "writeOnly":false }, "applicationId":{ "type":"string", "description":"Application Id on which the user is subscribed.", "readOnly":true, "writeOnly":false }, "isPrimary":{ "type":"boolean", "description":"Set to true if this device is a primary device of a user among other devices.", "readOnly":true, "writeOnly":false }, "registrationId":{ "type":"string", "description":"Push registration ID.", "readOnly":true, "writeOnly":false }, "systemData":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"System data collected from the user's profile", "readOnly":true, "writeOnly":false } }, "title":"IamPushContactV2" }, "62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteEntry":{ "type":"object", "properties":{ "query":{ "allOf":[ { "$ref":"#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.CompanyIdentityQuery" } ] } }, "title":"BatchDeleteEntry" }, "62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteRequest":{ "type":"object", "properties":{ "companies":{ "type":"array", "description":"List of companies.", "items":{ "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteEntry" }, "readOnly":false, "writeOnly":false } }, "title":"BatchDeleteRequest" }, "62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"List of any unsuccessful result from the batch operation for each processed entry. Example, name used in the request already exists.", "items":{ "$ref":"#/components/schemas/62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResult" }, "readOnly":false, "writeOnly":false } }, "title":"BatchDeleteResponse" }, "62d9ebafb4f8a59174952b52d2134c8b74a981fb89910acb47a5dc3a9064656e.BatchDeleteResult":{ "type":"object", "properties":{ "errors":{ "type":"array", "description":"List of errors", "items":{ "$ref":"#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError" }, "readOnly":false, "writeOnly":false }, "query":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Query used for company identification", "readOnly":false, "writeOnly":false }, "status":{ "type":"integer", "format":"int32", "description":"HTTP status", "readOnly":false, "writeOnly":false } }, "title":"BatchDeleteResult" }, "67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType":{ "type":"string", "enum":[ "ID", "EXTERNAL_ID", "PHONE", "EMAIL", "LINE", "FACEBOOK", "TELEGRAM", "PUSH", "WEB_PUSH", "LIVE_CHAT", "VIBER_BOTS", "INSTAGRAM", "INSTAGRAM_DM", "TWITTER", "APPLE_BUSINESS_CHAT", "KAKAO_SANGDAM", "OPEN_CHANNEL", "ZALO_FOLLOWER", "TIKTOK_BM", "WHATSAPP" ], "title":"PersonUniqueFieldType" }, "6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagEntry":{ "type":"object", "properties":{ "query":{ "allOf":[ { "$ref":"#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery" } ] } }, "title":"BatchTagEntry" }, "6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagRequest":{ "type":"object", "properties":{ "people":{ "type":"array", "description":"List of people.", "items":{ "$ref":"#/components/schemas/6e5093188ef762ccf12b90d36e576ec662722c76b160603b886937148ee4174f.BatchTagEntry" }, "readOnly":false, "writeOnly":false } }, "title":"BatchTagRequest" }, "731de3b862f8fe6ae84afd9eafc472a32d21c61fcef8ad54ed49d0a754dea9e0.IamTagV2":{ "type":"object", "properties":{ "createdAt":{ "type":"string", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "id":{ "type":"integer", "format":"int64", "description":"Unique id of the entity.", "readOnly":true, "writeOnly":false }, "modifiedAt":{ "type":"string", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "name":{ "type":"string", "description":"Tag name, 256 characters max.", "readOnly":false, "writeOnly":false } }, "title":"IamTagV2" }, "85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiException":{ "type":"object", "properties":{ "requestError":{ "allOf":[ { "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestError" } ] } }, "title":"ApiException" }, "85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestError":{ "type":"object", "properties":{ "serviceException":{ "allOf":[ { "$ref":"#/components/schemas/85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestErrorDetails" } ] } }, "title":"ApiRequestError" }, "85ef14f921059c8d596d8b833b8a149dc14381e2ba3cfb5faaea9e6ec02a0f36.ApiRequestErrorDetails":{ "type":"object", "properties":{ "messageId":{ "type":"string", "description":"Identifier of the error.", "readOnly":false, "writeOnly":false }, "text":{ "type":"string", "description":"Detailed error description.", "readOnly":false, "writeOnly":false } }, "title":"ApiRequestErrorDetails" }, "8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateRequest":{ "type":"object", "properties":{ "companies":{ "type":"array", "description":"List of companies.", "items":{ "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" }, "readOnly":false, "writeOnly":false } }, "title":"BatchCreateRequest" }, "8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"List of result from the batch operation for each processed entry. Example, the first company was created, the second company wasn't created because name already exists.", "items":{ "$ref":"#/components/schemas/8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResult" }, "readOnly":false, "writeOnly":false } }, "title":"BatchCreateResponse" }, "8f56537725b251ff8d954dfe25d40799c66fa1fccf8d6a81cf1331f5159a40d1.BatchCreateResult":{ "type":"object", "properties":{ "errors":{ "type":"array", "description":"List of errors", "items":{ "$ref":"#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError" }, "readOnly":false, "writeOnly":false }, "id":{ "type":"integer", "format":"int64", "description":"Id of created company", "readOnly":false, "writeOnly":false }, "index":{ "type":"integer", "format":"int32", "description":"Index of company in request list", "readOnly":false, "writeOnly":false }, "status":{ "type":"integer", "format":"int32", "description":"HTTP status", "readOnly":false, "writeOnly":false } }, "title":"BatchCreateResult" }, "9a0795f64a40f2cbc302ee52c186009a1de422921e2055e9284671cdc2107f5b.IamAdditionalFieldDataType":{ "type":"string", "enum":[ "STRING", "DECIMAL", "INTEGER", "BOOLEAN", "DATE", "DATE_TIME", "LIST_OF_OBJECTS" ], "title":"IamAdditionalFieldDataType" }, "ApiError":{ "type":"object", "properties":{ "errorCode":{ "type":"string", "description":"An error code uniquely identifying the error case." }, "description":{ "type":"string", "description":"A detailed description of an error." }, "action":{ "type":"string", "description":"An action that should be taken to recover from the error." }, "violations":{ "type":"array", "description":"List of violations that caused the error.", "items":{ "$ref":"#/components/schemas/ApiErrorViolation" } }, "resources":{ "type":"array", "description":"List of available resources to recover from the error.", "items":{ "$ref":"#/components/schemas/ApiErrorResource" } } }, "required":[ "action", "description", "errorCode", "resources", "violations" ], "title":"ApiError" }, "ApiErrorResource":{ "type":"object", "description":"List of available resources to recover from the error.", "properties":{ "name":{ "type":"string", "description":"Resource name." }, "url":{ "type":"string", "description":"Resource URL." } }, "title":"ApiErrorResource" }, "ApiErrorViolation":{ "type":"object", "description":"List of violations that caused the error.", "properties":{ "property":{ "type":"string", "description":"Request property that caused the error." }, "violation":{ "type":"string", "description":"Detailed violation description." } }, "title":"ApiErrorViolation" }, "ApiException":{ "type":"object", "properties":{ "requestError":{ "$ref":"#/components/schemas/ApiRequestError" } }, "title":"ApiException" }, "ApiRequestError":{ "type":"object", "properties":{ "serviceException":{ "$ref":"#/components/schemas/ApiRequestErrorDetails" } }, "title":"ApiRequestError" }, "ApiRequestErrorDetails":{ "type":"object", "properties":{ "messageId":{ "type":"string", "description":"Identifier of the error." }, "text":{ "type":"string", "description":"Detailed error description." }, "validationErrors":{ "type":"object", "additionalProperties":{ "type":"array", "description":"Validation errors.", "items":{ "type":"string", "description":"Validation errors." } }, "description":"Validation errors." } }, "title":"ApiRequestErrorDetails" }, "a1a8ff0e2d4e8815c87f131be18d5198cdc635a778df6b963f0f0a4b59822f94.ExportRequestBody":{ "type":"object", "properties":{ "roleArn":{ "type":"string", "description":"AWS role ARN for accessing S3 bucket. Accepted format: `arn:aws:iam::account:role/role-name-with-path`. Must apply character rules as referenced in [AWS documentation](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html).", "writeOnly":true }, "bucket":{ "type":"string", "description":"AWS S3 bucket name. Must only contain safe characters, as defined in [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).", "writeOnly":true }, "region":{ "type":"string", "description":"AWS S3 client region.", "writeOnly":true }, "directoryPath":{ "type":"string", "description":"AWS S3 directory path. Use `directory/` or a nested directory path `dir1/dir2/directory/`. Must only contain safe characters or an equal sign, as defined in [AWS documentation](https://docs.aws.amazon.com/AmazonS3/latest/userguide/object-keys.html).", "writeOnly":true }, "startTime":{ "type":"string", "description":"Start time of the export query. Accepted format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g. `2022-03-01T01:00:00.000+0000`. Must be earlier than the current time and `endTime`, but no more than 1 year ago. `startTime` and `endTime` must be at most 24 hours apart.", "writeOnly":true }, "endTime":{ "type":"string", "description":"End time of the export query. Accepted format: `yyyy-MM-dd'T'HH:mm:ss.SSSZ`, e.g. `2022-03-01T01:00:00.000+0000`. Must be earlier than the current time, and later than `startTime`. `startTime` and `endTime` must be at most 24 hours apart.", "writeOnly":true }, "definitionIdList":{ "type":"array", "description":"An optional list of `definitionId`s to use as a whitelist filter for exported events. Accepted format: `[\"definitionId\", \"definitionId\"]`, e.g. `[\"formSubmitted\", \"sms*\"]`. A wildcard character '*' may be used to match any number of characters in the `definitionId`. A list of all valid `definitionId`s can be obtained from the [Get list of event definitions](https://www.infobip.com/docs/api#customer-engagement/people/get-events-definitions-for-export) endpoint. The total number of matched `definitionId`s, after wildcard expansion, may not exceed 200. To export all events without filtering, do not specify a `definitionIdList`.", "items":{ "type":"string" }, "maxItems":200, "uniqueItems":true, "writeOnly":true }, "enrichWithMomentsInfo":{ "type":"boolean", "description":"If set to `true`, additional information, namely the campaign name, Flow's element name (if applicable), and the campaign start date and time are added to all existing events related to Moments. Defaults to `false`.", "writeOnly":true } }, "required":[ "bucket", "endTime", "region", "roleArn", "startTime" ], "title":"ExportRequestBody" }, "a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.DefinitionsResponseBody":{ "type":"object", "properties":{ "definitionIdList":{ "type":"array", "description":"Available `definitionId`s.", "items":{ "type":"string", "description":"Available `definitionId`s.", "readOnly":true }, "readOnly":true } }, "required":[ "definitionIdList" ], "title":"DefinitionsResponseBody" }, "a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.ExportResponseBody":{ "type":"object", "properties":{ "requestId":{ "type":"string", "description":"Event export request ID.", "readOnly":true } }, "required":[ "requestId" ], "title":"ExportResponseBody" }, "a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.RequestStatus":{ "type":"string", "description":"Status of the data export request.", "enum":[ "SUBMITTED", "IN_PROGRESS", "COMPLETED_SUCCESSFULLY", "FAILED_AWAITING_RETRY", "FAILED_AFTER_MAX_RETRIES", "CANCELLED_BY_CUSTOMER" ], "readOnly":true, "title":"RequestStatus" }, "a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.StatusResponseBody":{ "type":"object", "properties":{ "requestId":{ "type":"string", "description":"Request ID of the data export request, the status of which is being queried on the [GET status](#customer-engagement/people/get-events-export-request-status) endpoint.", "readOnly":true }, "status":{ "$ref":"#/components/schemas/a389f65d9a8b852c007cdb5a24c983f5c2dc5fa67bb655d3284926dc5c3ce095.RequestStatus" }, "message":{ "type":"string", "description":"Completion message of data export request, if applicable.", "readOnly":true } }, "required":[ "requestId", "status" ], "title":"StatusResponseBody" }, "a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamIntegrationsV2":{ "type":"object", "properties":{ "salesforce":{ "allOf":[ { "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamSalesforceV2" } ], "description":"Salesforce integration.", "readOnly":false, "writeOnly":false } }, "title":"IamIntegrationsV2" }, "a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2":{ "type":"object", "properties":{ "address":{ "type":"string", "description":"Person's address, 256 characters max.", "readOnly":false, "writeOnly":false }, "birthDate":{ "type":"string", "description":"Person's date of birth, format `YYYY-MM-DD`.", "readOnly":false, "writeOnly":false }, "city":{ "type":"string", "description":"Person's city, 50 characters max.", "readOnly":false, "writeOnly":false }, "computedAttributes":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Person's computed attributes grouped by type.", "readOnly":true, "writeOnly":false }, "contactInformation":{ "allOf":[ { "$ref":"#/components/schemas/61aa42c3f981b5eedf39f88f62d783e335a4e6b75d3b1bbc6a07b0633bb93eb9.IamPersonContactsV2" } ], "description":"List of phones, emails and other information how a person can be contacted.", "readOnly":false, "writeOnly":false }, "country":{ "type":"string", "description":"Person's country, 50 characters max.", "readOnly":false, "writeOnly":false }, "createdAt":{ "type":"string", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "customAttributes":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"List of custom attributes for the person, 4096 characters max per value.", "readOnly":false, "writeOnly":false }, "externalId":{ "type":"string", "description":"Unique ID for a person from your or another external system, 256 characters max.", "readOnly":false, "writeOnly":false }, "firstName":{ "type":"string", "description":"Person's first name, 255 characters max.", "readOnly":false, "writeOnly":false }, "gender":{ "allOf":[ { "$ref":"#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamGender" } ], "description":"Person's gender.", "readOnly":false, "writeOnly":false }, "id":{ "type":"integer", "format":"int64", "description":"Unique id of the entity.", "readOnly":true, "writeOnly":false }, "integrations":{ "allOf":[ { "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamIntegrationsV2" } ], "description":"Integrations.", "readOnly":true, "writeOnly":false }, "lastName":{ "type":"string", "description":"Person's last name, 255 characters max.", "readOnly":false, "writeOnly":false }, "middleName":{ "type":"string", "description":"Person's middle name, 50 characters max.", "readOnly":false, "writeOnly":false }, "modifiedAt":{ "type":"string", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "modifiedFrom":{ "allOf":[ { "$ref":"#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin" } ], "description":"The information which describes the source of the last modification of record.", "readOnly":true, "writeOnly":false }, "origin":{ "allOf":[ { "$ref":"#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin" } ], "description":"The information which describes the origin of the record.", "readOnly":true, "writeOnly":false }, "preferredLanguage":{ "type":"string", "description":"Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.", "readOnly":false, "writeOnly":false }, "profilePicture":{ "type":"string", "description":"URL for the person's profile picture, 2083 characters max.", "readOnly":false, "writeOnly":false }, "tags":{ "type":"array", "description":"List of tags that this person has.", "items":{ "type":"string" }, "readOnly":false, "writeOnly":false }, "type":{ "allOf":[ { "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamTypeV2" } ], "description":"Person's type, default type is CUSTOMER.", "readOnly":false, "writeOnly":false } }, "title":"IamPersonV2" }, "a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamSalesforceV2":{ "type":"object", "properties":{ "contactId":{ "type":"string", "description":"Salesforce contact id.", "readOnly":false, "writeOnly":false }, "leadId":{ "type":"string", "description":"Salesforce lead id.", "readOnly":false, "writeOnly":false } }, "title":"IamSalesforceV2" }, "a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamTypeV2":{ "type":"string", "enum":[ "CUSTOMER", "LEAD" ], "title":"IamTypeV2" }, "b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonOttContact":{ "type":"object", "properties":{ "applicationId":{ "type":"string", "description":"Application Id on which the user is subscribed.", "readOnly":true, "writeOnly":false }, "systemData":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"System data collected from the user's profile.", "readOnly":true, "writeOnly":false }, "userId":{ "type":"string", "description":"Unique user ID for a person.", "readOnly":true, "writeOnly":false } }, "title":"CommonOttContact" }, "b19dbfd240ca6293d80ae57437ec266d186a81682210bc56a1b7636c4c62d0e7.CommonPushContact":{ "type":"object", "properties":{ "additionalData":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Additional data collected from the user's profile", "readOnly":true, "writeOnly":false }, "applicationId":{ "type":"string", "description":"Application Id on which the user is subscribed.", "readOnly":true, "writeOnly":false }, "registrationId":{ "type":"string", "description":"Push registration ID.", "readOnly":true, "writeOnly":false }, "systemData":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"System data collected from the user's profile", "readOnly":true, "writeOnly":false } }, "title":"CommonPushContact" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsItemResponse":{ "type":"object", "description":"", "properties":{ "property":{ "type":"string", "description":"The name of the specific property or field related to the error." }, "message":{ "type":"string", "description":"A descriptive message explaining the nature of the error associated with the property." } }, "required":[ "message", "property" ], "title":"ErrorDetailsItemResponse" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsResponse":{ "type":"object", "description":"An object containing specific information about an error.", "properties":{ "index":{ "type":"integer", "format":"int32", "description":"The position of the entity in the request array that caused the error. An index of -1 indicates a general error not tied to a specific entity." }, "code":{ "type":"integer", "format":"int32", "description":"A specific error code that categorizes the type of error, aiding in quick identification and resolution." }, "message":{ "type":"string", "description":"A descriptive message explaining the nature of the error." }, "details":{ "type":"array", "description":"An array providing additional context about specific aspects of the error.", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsItemResponse" } } }, "required":[ "code", "index", "message" ], "title":"ErrorDetailsResponse" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventBatchResourceRequest":{ "type":"array", "description":"An array of events submitted as a batch request for processing.", "items":{ "type":"object", "properties":{ "eventId":{ "type":[ "string", "null" ], "description":"Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.
The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only." }, "definitionId":{ "type":"string", "description":"Unique identifier of event schema." }, "occurredTime":{ "type":"string", "format":"date-time", "description":"Time of event occurrence, as the following format `yyyy-MM-dd'T'HH:mm:ss.SSSZ`. Events occurred more than 30 days ago will be rejected. Future dates are not allowed and will be automatically set to the current UTC time.", "example":"2025-03-17T13:00:27.864Z" }, "identifier":{ "type":"object", "description":"Used to match the event to an existing person profile using the provided identifier.
If no matching profile is found, a new profile will be automatically created.
**Note**: New profiles can only be created for the following identifier types: `PHONE`, `EMAIL`, or `EXTERNAL_ID`.", "properties":{ "id":{ "type":"string", "description":"Unique identifier of the person who performed the event. The value must match the `type` property." }, "type":{ "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.PersonUniqueFieldType" }, "sender":{ "type":[ "string", "null" ], "description":"Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`." } }, "required":[ "id", "type" ] }, "properties":{ "type":[ "object", "null" ], "additionalProperties":{ "type":"object" }, "description":"Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types." } }, "required":[ "definitionId", "identifier", "occurredTime" ] }, "title":"EventBatchResourceRequest" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionCreateResource":{ "type":"object", "additionalProperties":false, "properties":{ "templateId":{ "type":[ "string", "null" ], "description":"Template identifier. Used when the client wants to create a definition from a template. Must contain only alphanumeric characters `(a–z, A–Z, 0–9)`. Maximum length: `36` characters. Must be `null` if `definitionId` is provided.", "pattern":"^[a-zA-Z0-9]{0,36}$" }, "definitionId":{ "type":[ "string", "null" ], "description":"Event definition identifier. Must contain only alphanumeric characters `(a–z, A–Z, 0–9)`. Maximum length: `36` characters. Must be `null` if `templateId` is provided. Cannot have a value from the list of predefined (standard) definitions.", "pattern":"^[a-zA-Z0-9]{0,36}$" }, "title":{ "type":[ "string", "null" ], "description":"Event definition title. Required if `templateId` is `null`. Maximum length: `100` characters. Must be `null` if `templateId` is provided." }, "description":{ "type":[ "string", "null" ], "description":"Event definition description. Maximum length: `2000` characters if `templateId` is `null`. Must be `null` if `templateId` is provided." }, "fields":{ "type":[ "array", "null" ], "description":"Event definition fields. The total number of fields cannot exceed `120`. Field names must be unique (case-insensitive). The number of fields of type `List` cannot exceed `1`.", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource" }, "maxItems":120, "uniqueItems":true } }, "title":"EventDefinitionCreateResource" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionResource":{ "type":"object", "additionalProperties":false, "properties":{ "isInternalDefinition":{ "type":"boolean", "description":"Indicates whether this is a standard (internal) event definition provided by the system, or a custom (external) definition created by the user." }, "category":{ "type":"null", "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory" } ], "description":"Event definition category." }, "subcategory":{ "type":"null", "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionSubcategory" } ], "description":"Event definition subcategory, providing more granular classification within the main category." }, "definitionId":{ "type":[ "string", "null" ], "description":"Event definition identifier." }, "title":{ "type":[ "string", "null" ], "description":"Event definition title." }, "description":{ "type":[ "string", "null" ], "description":"Event definition description." }, "fields":{ "type":[ "array", "null" ], "description":"Event definition fields describing the structure and data types of the event properties.", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource" }, "uniqueItems":true } }, "title":"EventDefinitionResource" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventDefinitionUpdateResource":{ "type":"object", "additionalProperties":false, "properties":{ "title":{ "type":"string", "description":"Event definition title. Must not be empty. Maximum length: `100` characters.
**Note**: The title cannot be changed for a template definition. If the client tries to update the value, it will be overwritten with the standard title from the template.", "maxLength":100, "minLength":1 }, "description":{ "type":[ "string", "null" ], "description":"Event definition description. Maximum length: `2000` characters.
**Note**: The description cannot be changed for a template definition. If the client tries to update the value, it will be overwritten with the standard description from the template.", "maxLength":2000 }, "fields":{ "type":[ "array", "null" ], "description":"Event definition fields. The total number of fields cannot exceed `120`. Field names must be unique (case-insensitive). The number of fields of type `List` cannot exceed `1`. Only new fields can be added; existing fields **cannot** be removed or changed.", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource" }, "maxItems":120, "uniqueItems":true } }, "required":[ "title" ], "title":"EventDefinitionUpdateResource" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventFieldResource":{ "type":"object", "additionalProperties":false, "properties":{ "name":{ "type":"string", "description":"Field name. Must not exceed `128` characters. Must start with a lowercase letter `(a–z)` and can contain alphanumeric characters `(A–Z, a–z, 0–9)` and underscores `(_)`.", "maxLength":128, "minLength":1, "pattern":"^[a-z_][a-zA-Z0-9_]*$" }, "type":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventFieldType" } ], "description":"Field data type.", "minLength":1 }, "schema":{ "allOf":[ { "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemResource" } ], "description":"Schema definition for List type fields. Must be `null` when type is not `List`. Must be provided and valid when type equals `List`." } }, "required":[ "name", "type" ], "title":"EventFieldResource" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.EventResourceResponse":{ "type":"object", "properties":{ "eventId":{ "type":"string", "description":"Unique identifier of the event." }, "definitionId":{ "type":"string", "description":"Unique identifier of event schema." }, "occurredTime":{ "type":"string", "format":"date-time", "description":"Time of event occurrence, as the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ", "example":"2024-05-17T15:47:50.413Z" }, "properties":{ "type":[ "object", "null" ], "additionalProperties":{ "type":"object" }, "description":"Object that contains event properties." }, "metadata":{ "type":[ "object", "null" ], "additionalProperties":{ "type":"object" }, "description":"Object that contains metadata of event occurrence." } }, "title":"EventResourceResponse" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemFieldResource":{ "type":"object", "additionalProperties":false, "properties":{ "name":{ "type":"string", "description":"Field name within a List item. Must not exceed `128` characters. Must start with a lowercase letter `(a–z)` and can contain alphanumeric characters `(A–Z, a–z, 0–9)` and underscores `(_)`.", "maxLength":128, "minLength":1, "pattern":"^[a-z_][a-zA-Z0-9_]*$" }, "type":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemFieldType" } ], "description":"Field data type within a List item.
**Note**: `List` type is not allowed for nested fields.", "minLength":1 } }, "required":[ "name", "type" ], "title":"ListItemFieldResource" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemResource":{ "type":"object", "additionalProperties":false, "properties":{ "type":{ "allOf":[ { "$ref":"#/components/schemas/fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemType" } ], "description":"Schema type for List items. Must be `Object`.", "minLength":1 }, "fields":{ "type":"array", "description":"Fields within the List item object. Must not be empty, must contain no more than `128` items, field names must be unique (case-insensitive).", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ListItemFieldResource" }, "maxItems":128, "minItems":1, "uniqueItems":true } }, "required":[ "fields", "type" ], "title":"ListItemResource" }, "b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ProblemDetailsResponse":{ "type":"object", "description":"A structured response that provides detailed information about validation errors encountered during an API request.", "properties":{ "status":{ "type":"integer", "format":"int32", "description":"The HTTP status code indicating the nature of the error." }, "title":{ "type":"string", "description":"A short, human-readable summary of the error type. This title remains consistent across similar error occurrences, aiding in easy identification." }, "type":{ "type":"string", "format":"uri", "description":"A URI reference that provides additional information about the error type." }, "traceId":{ "type":"string", "description":"A unique identifier for the request, useful for tracing purposes. This ID helps in correlating logs and tracking the request through the system." }, "errors":{ "type":"array", "description":"An array containing detailed information about each error encountered.", "items":{ "$ref":"#/components/schemas/b3ed157de85ce51bb7c17933fb84ff4b3e9bcb9fb8576a5ae189b97589d5bd1c.ErrorDetailsResponse" } } }, "required":[ "status", "title", "type" ], "title":"ProblemDetailsResponse" }, "bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamGender":{ "type":"string", "enum":[ "MALE", "FEMALE" ], "title":"IamGender" }, "bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin":{ "type":"string", "enum":[ "API", "PORTAL", "WEB_SDK", "INTEGRATION", "PUSH", "FACEBOOK", "LINE", "TELEGRAM", "SALESFORCE", "DYNAMICS", "ZAPIER", "FORMS", "COMPUTED", "ANSWERS", "CONVERSATIONS" ], "title":"IamOrigin" }, "c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateRequest":{ "type":"object", "properties":{ "people":{ "type":"array", "description":"List of people.", "items":{ "$ref":"#/components/schemas/a8ed60f1ed4abc0dfe4d5460edd3205f89585f2cd4b436e4d83a1231d28c264c.IamPersonV2" }, "readOnly":false, "writeOnly":false } }, "title":"BatchCreateRequest" }, "c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.", "items":{ "$ref":"#/components/schemas/c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResult" }, "readOnly":false, "writeOnly":false } }, "title":"BatchCreateResponse" }, "c33895ecf7bbac41312b872d159ba76eaa0387a04e1ff6d8280d7b04d6e7955c.BatchCreateResult":{ "type":"object", "properties":{ "errors":{ "type":"array", "description":"List of errors", "items":{ "$ref":"#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError" }, "readOnly":false, "writeOnly":false }, "index":{ "type":"integer", "format":"int32", "description":"Index of person in request list", "readOnly":false, "writeOnly":false }, "status":{ "type":"integer", "format":"int32", "description":"HTTP status", "readOnly":false, "writeOnly":false } }, "title":"BatchCreateResult" }, "d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteEntry":{ "type":"object", "properties":{ "query":{ "allOf":[ { "$ref":"#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery" } ] } }, "title":"BatchDeleteEntry" }, "d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteRequest":{ "type":"object", "properties":{ "people":{ "type":"array", "description":"List of people.", "items":{ "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteEntry" }, "readOnly":false, "writeOnly":false } }, "title":"BatchDeleteRequest" }, "d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"List of any unsuccessful result from the batch operation for each processed entry. Example, email used in the request already exists.", "items":{ "$ref":"#/components/schemas/d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResult" }, "readOnly":false, "writeOnly":false } }, "title":"BatchDeleteResponse" }, "d0ee6832b8ae2ba6d1bb41f4a297ed26f313a0be247c3016b7bdbb963195d2de.BatchDeleteResult":{ "type":"object", "properties":{ "errors":{ "type":"array", "description":"List of errors", "items":{ "$ref":"#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError" }, "readOnly":false, "writeOnly":false }, "query":{ "allOf":[ { "$ref":"#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery" } ] }, "status":{ "type":"integer", "format":"int32", "description":"HTTP status", "readOnly":false, "writeOnly":false } }, "title":"BatchDeleteResult" }, "d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery":{ "type":"object", "properties":{ "identifier":{ "type":"string", "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", "readOnly":false, "writeOnly":false }, "sender":{ "type":"string", "description":"Sender or application ID. `sender` is required for all identifier types except `ID`, `EXTERNAL_ID`, `PHONE`, `EMAIL`.", "readOnly":false, "writeOnly":false }, "type":{ "allOf":[ { "$ref":"#/components/schemas/67ea2a2f468d202db25df7b2d86e54c3628a74b47c8fd9cf8429d0e9a038dd27.PersonUniqueFieldType" } ], "description":"Type of the person ID. Can be one of the above", "readOnly":false, "writeOnly":false } }, "title":"IdentityQuery" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationTypeV3":{ "type":"string", "description":"Type of the person ID", "enum":[ "PHONE", "EMAIL", "FACEBOOK", "LINE", "TELEGRAM", "PUSH", "WEB_PUSH", "LIVE_CHAT", "VIBER_BOTS", "INSTAGRAM", "TWITTER", "INSTAGRAM_DM", "KAKAO_SANGDAM", "APPLE_BUSINESS_CHAT", "OPEN_CHANNEL", "ZALO_FOLLOWER", "TIKTOK_BM", "WHATSAPP", "KAKAO_TALK" ], "example":"PHONE", "title":"ContactInformationTypeV3" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationV3":{ "type":"object", "description":"List of phones, emails and other information how a person can be contacted.", "properties":{ "type":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationTypeV3" }, "identifier":{ "type":"string", "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. 255 characters max.", "example":"41793026727", "maxLength":255, "minLength":0 }, "sender":{ "type":"string", "description":"Sender or application ID. Sender is required for all identifier types except PHONE and EMAIL. 255 characters max.", "example":"41793026728", "maxLength":255, "minLength":0 }, "primary":{ "type":"boolean", "description":"Indicates if this ID is preferred for communication.", "example":true } }, "required":[ "identifier", "type" ], "title":"ContactInformationV3" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto":{ "type":"object", "description":"List of events that persons should match.", "properties":{ "definitionId":{ "type":"string", "description":"Event definition ID.", "example":"addedToCart" }, "occurrenceCondition":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionDto" }, "timelineCondition":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionDto" }, "payloadConditions":{ "type":"array", "description":"Specify the conditions of the event payload.", "items":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadConditionDto" } } }, "required":[ "definitionId", "timelineCondition" ], "title":"EventClauseDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionDto":{ "type":"object", "description":"Specify how many times did the event occur.", "properties":{ "operation":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionOperation" }, "times":{ "type":"integer", "format":"int32", "description":"Number of times the event has occurred.", "example":5 } }, "required":[ "operation", "times" ], "title":"OccurrenceConditionDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OccurrenceConditionOperation":{ "type":"string", "description":"Operation to compare how many times the event has occurred.", "enum":[ "IS", "LESS_THAN", "LESS_OR_EQUAL", "GREATER_OR_EQUAL", "GREATER_THAN" ], "example":"IS", "title":"OccurrenceConditionOperation" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OriginV3":{ "type":"string", "description":"Source system that last modified this person record.", "enum":[ "API", "PORTAL", "WEB_SDK", "INTEGRATION", "PUSH", "FACEBOOK", "LINE", "TELEGRAM", "SALESFORCE", "DYNAMICS", "ZAPIER", "FORMS", "AMS", "COMPUTED", "ANSWERS", "CONVERSATIONS", "IMPORT", "INSTAGRAM_DM", "FLOW", "LIVE_CHAT", "VKONTAKTE", "ZALO_FOLLOWER", "TIKTOK_BM", "WHATSAPP", "KAKAO_TALK", "UNKNOWN" ], "example":"API", "readOnly":true, "title":"OriginV3" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageInfo":{ "type":"object", "description":"Contains information about the page.", "properties":{ "page":{ "type":"integer", "format":"int32", "description":"Requested page number.", "minimum":0 }, "size":{ "type":"integer", "format":"int32", "description":"Requested page size.", "minimum":1 }, "totalPages":{ "type":"integer", "format":"int32", "description":"The total number of pages of the results matching the requested parameters.", "minimum":0 }, "totalResults":{ "type":"integer", "format":"int64", "description":"The total number of the results matching the requested parameters.", "minimum":0 } }, "required":[ "page", "size", "totalPages", "totalResults" ], "title":"PageInfo" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PagePersonV3":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonV3" } }, "paging":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageInfo" } }, "required":[ "paging", "results" ], "title":"PagePersonV3" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageSegmentResponseDto":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"The list of the results for this page.", "items":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto" } }, "paging":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PageInfo" } }, "required":[ "paging", "results" ], "title":"PageSegmentResponseDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadConditionDto":{ "type":"object", "description":"Specify the conditions of the event payload.", "properties":{ "attribute":{ "type":"string", "description":"Event payload attribute.", "example":"itemId" }, "operator":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadOperator" }, "value":{ "type":"string", "description":"Payload condition value.", "example":"10001" } }, "required":[ "attribute", "operator", "value" ], "title":"PayloadConditionDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PayloadOperator":{ "type":"string", "description":"Operator for comparing condition value with payload value.", "enum":[ "EQ", "LT", "LTE", "GT", "GTE", "NE", "SW", "EW", "CON" ], "example":"EQ", "title":"PayloadOperator" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonGenderV3":{ "type":"string", "description":"Person's gender.", "enum":[ "MALE", "FEMALE" ], "example":"FEMALE", "title":"PersonGenderV3" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonTypeV3":{ "type":"string", "description":"Person's type, default type is CUSTOMER.", "enum":[ "CUSTOMER", "LEAD" ], "example":"CUSTOMER", "title":"PersonTypeV3" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonV3":{ "type":"object", "description":"The list of the results for this page.", "properties":{ "id":{ "type":"integer", "format":"int64", "description":"Unique id of the entity.", "example":1, "readOnly":true }, "externalId":{ "type":"string", "description":"Unique ID for a person from your or another external system, 256 characters max.", "example":"3", "maxLength":256, "minLength":0 }, "type":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonTypeV3" }, "firstName":{ "type":"string", "description":"Person's first name, 255 characters max.", "example":"Jane", "maxLength":255, "minLength":0 }, "middleName":{ "type":"string", "description":"Person's middle name, 50 characters max.", "example":"Janie", "maxLength":50, "minLength":0 }, "lastName":{ "type":"string", "description":"Person's last name, 255 characters max.", "example":"Smith", "maxLength":255, "minLength":0 }, "nickName":{ "type":"string", "description":"Person's nick name, 50 characters max.", "example":"Janey", "maxLength":50, "minLength":0 }, "country":{ "type":"string", "description":"Person's country, 50 characters max.", "example":"United Kingdom", "maxLength":50, "minLength":0 }, "city":{ "type":"string", "description":"Person's city, 50 characters max.", "example":"London", "maxLength":50, "minLength":0 }, "address":{ "type":"string", "description":"Person's address, 256 characters max.", "example":"67 Farringdon Road", "maxLength":256, "minLength":0 }, "gender":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.PersonGenderV3" }, "preferredLanguage":{ "type":"string", "description":"Person's preferred language. Must be in two letter ISO (xx) or language-region BCP-47 (xx-YY) format.", "example":"en-gb" }, "birthDate":{ "type":"string", "format":"date", "description":"Person's date of birth, format `YYYY-MM-DD`.", "example":"1966-01-15" }, "profilePicture":{ "type":"string", "format":"url", "description":"URL for the person's profile picture, 2083 characters max.", "example":"http://profile.com", "maxLength":2083, "minLength":0 }, "tags":{ "type":"array", "description":"List of tags that this person has.", "example":[ "tag1", "tag2" ], "items":{ "type":"string", "description":"List of tags that this person has.", "example":"[\"tag1\",\"tag2\"]" }, "uniqueItems":true }, "contactInformation":{ "type":"array", "description":"List of phones, emails and other information how a person can be contacted.", "items":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.ContactInformationV3" } }, "customAttributes":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "Contract Expiry":"2024-06-12", "Company":"ACME" } }, "description":"List of custom attributes for the person, 4096 characters max per value.", "example":{ "Contract Expiry":"2024-06-12", "Company":"ACME" } }, "computedAttributes":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "fullName":"Jane Smith" }, "readOnly":true }, "description":"Person's computed attributes grouped by type.", "example":{ "fullName":"Jane Smith" }, "readOnly":true }, "createdFrom":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OriginV3" }, "createdBy":{ "type":"string", "description":"Identifier of the user who created this person record.", "example":"5", "readOnly":true }, "createdAt":{ "type":"string", "format":"date-time", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true }, "modifiedFrom":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.OriginV3" }, "modifiedBy":{ "type":"string", "description":"Identifier of the user who last modified this person record.", "example":"5", "readOnly":true }, "modifiedAt":{ "type":"string", "format":"date-time", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true } }, "title":"PersonV3" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentCreateDto":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"A unique segment name.", "example":"VIP Alex Clients" }, "description":{ "type":"string", "description":"Segment description.", "example":"Persons named Alex with tag \"VIP Client\"" }, "query":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "#and":[ { "firstName":"Alex" }, { "#contains":{ "tags":"VIP Client" } } ] } }, "description":"\nAllows to filter persons using simple queries.\n\n##### Supported logical operators\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
OperatorDescriptionExample
#andAll records that match the conditions of all clauses.{\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]}
#orAll records that match the conditions of any clause.{\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]}
\n\n##### Supported comparison operators\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
AttributesDescriptionExample
#notExistMatches records that do not have given attribute.{\"#notExist\":\"firstName\"}
#existMatches records that have given attribute.{\"#exists\":\"firstName\"}
StringsDescriptionExample
#eqEquals to a specified string.{\"firstName\":\"John\"}
#neNot equal to a specified string.{\"#ne\":{\"firstName\":\"John\"}}
#startsWithStarts with a specified string.{\"#startsWith\":{\"firstName\":\"John\"}}
#endsWithEnds with a specified string.{\"#endsWith\":{\"firstName\":\"John\"}}
#containsContains a specified string.{\"#contains\":{\"firstName\":\"oh\"}}
#notContainDoes not contain a specified string.{\"#notContain\":{\"firstName\":\"oh\"}}
#inAt least one of the strings in a list.{\"#in\":{\"firstName\":[\"John\",\"Jane\"]}}
#notInNot any of the strings in a list.{\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}}
DatesDescriptionExample
#eqEquals to a specified date.{\"birthDate\":\"1987-07-10\"}
#neNot equal to a specified date.{\"#ne\":{\"birthDate\":\"1987-07-10\"}}
#eq (relative)Will be in specified interval.{\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#lt (relative)Will be within a specified interval.{\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#gt (relative)Will be in more than a specified interval.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#eq (relative) -Was a specified interval ago.{\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#gt (relative) -Was within a specified interval ago.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#gt (relative) -Was more than a specified interval ago.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#ltIs before a specified date.{\"#lt\":{\"birthDate\":\"1987-07-10\"}}
#lteIs before or equal to a specified date.{\"#lte\":{\"birthDate\":\"1987-07-10\"}}
#gtIs after a specified date.{\"#gt\":{\"birthDate\":\"1987-07-10\"}}
#gteIs after or equal to a specified date.{\"#gte\":{\"birthDate\":\"1987-07-10\"}}
#inIs equal to one of dates in a given list.{\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}
#notInIs not equal to any of dates in a given list.{\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}
IntegersDescriptionExample
#eqEquals to a specified integer.{\"data\\u0001counter\":1}
#neNot equal to a specified integer.{\"#ne\":{\"data\\u0001counter\":1}}
#ltIs less than a specified integer.{\"#lt\":{\"data\\u0001counter\":1}}
#lteIs less than or equal to a specified integer.{\"#lte\":{\"data\\u0001counter\":1}}
#gtIs greater than a specified integer.{\"#gt\":{\"data\\u0001counter\":1}}
#gteIs greater than or equal to a specified integer.{\"#gte\":{\"data\\u0001counter\":1}}
#inIs equal to any of specified integers in a list.{\"#in\":{\"data\\u0001counter\":[1,2,3]}}
#notInIs not equal to any of specified integers in a list.{\"#notIn\":{\"data\\u0001counter\":[1,2,3]}}
DecimalsDescriptionExample
#eqEquals to a specified decimal.{\"data\\u0001price\":1.1}
#neIs not equal to a specified decimal.{\"#ne\":{\"data\\u0001price\":1.1}}
#ltIs less than a specified decimal.{\"#lt\":{\"data\\u0001price\":1.1}}
#lteIs less than or equal to a specified decimal.{\"#lte\":{\"data\\u0001price\":1.1}}
#gtIs greater than a specified decimal.{\"#gt\":{\"data\\u0001price\":1.1}}
#gteIs greater than or equal to a specified decimal.{\"#gte\":{\"data\\u0001price\":1.1}}
#inIs equal to any of specified decimals in a list.{\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}}
#notInIs not equal to any of specified decimals in a list.{\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}}
BooleansDescriptionExample
#eqEquals to a specified boolean.{\"data\\u0001happy\":true}
#neNot equal to a specified boolean.{\"#ne\":{\"data\\u0001happy\":true}}
TagsDescriptionExample
#containsContains a specified tag.{\"#contains\":{\"tags\":\"SOME_TAG\"}}
#notContainDoes not contain a specified tag.{\"#notContain\":{\"tags\":\"SOME_TAG\"}}
GenderDescriptionExample
#eqEquals a specified gender.{\"gender\":\"MALE\"}
#neDoes not equal a specified gender.{\"#ne\":{\"gender\":\"FEMALE\"}}
ListsDescriptionExample
#allAll items in the list match.{\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}\n
#anyAny item in the list match.{\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}\n
\n\n", "example":{ "#and":[ { "firstName":"Alex" }, { "#contains":{ "tags":"VIP Client" } } ] } }, "events":{ "type":"array", "description":"List of events that persons should match.", "items":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto" } } }, "required":[ "name" ], "title":"SegmentCreateDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentResponseDto":{ "type":"object", "properties":{ "id":{ "type":"integer", "format":"int64", "description":"A unique segment identifier.", "example":42 }, "name":{ "type":"string", "description":"A unique segment name.", "example":"VIP Alex Clients" }, "description":{ "type":"string", "description":"Segment description.", "example":"Persons named Alex with tag \"VIP Client\"" }, "query":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "#and":[ { "firstName":"Alex" }, { "#contains":{ "tags":"VIP Client" } } ] } }, "description":"\nAllows to filter persons using simple queries.\n\n##### Supported logical operators\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
OperatorDescriptionExample
#andAll records that match the conditions of all clauses.{\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]}
#orAll records that match the conditions of any clause.{\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]}
\n\n##### Supported comparison operators\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
AttributesDescriptionExample
#notExistMatches records that do not have given attribute.{\"#notExist\":\"firstName\"}
#existMatches records that have given attribute.{\"#exists\":\"firstName\"}
StringsDescriptionExample
#eqEquals to a specified string.{\"firstName\":\"John\"}
#neNot equal to a specified string.{\"#ne\":{\"firstName\":\"John\"}}
#startsWithStarts with a specified string.{\"#startsWith\":{\"firstName\":\"John\"}}
#endsWithEnds with a specified string.{\"#endsWith\":{\"firstName\":\"John\"}}
#containsContains a specified string.{\"#contains\":{\"firstName\":\"oh\"}}
#notContainDoes not contain a specified string.{\"#notContain\":{\"firstName\":\"oh\"}}
#inAt least one of the strings in a list.{\"#in\":{\"firstName\":[\"John\",\"Jane\"]}}
#notInNot any of the strings in a list.{\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}}
DatesDescriptionExample
#eqEquals to a specified date.{\"birthDate\":\"1987-07-10\"}
#neNot equal to a specified date.{\"#ne\":{\"birthDate\":\"1987-07-10\"}}
#eq (relative)Will be in specified interval.{\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#lt (relative)Will be within a specified interval.{\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#gt (relative)Will be in more than a specified interval.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#eq (relative) -Was a specified interval ago.{\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#gt (relative) -Was within a specified interval ago.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#gt (relative) -Was more than a specified interval ago.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#ltIs before a specified date.{\"#lt\":{\"birthDate\":\"1987-07-10\"}}
#lteIs before or equal to a specified date.{\"#lte\":{\"birthDate\":\"1987-07-10\"}}
#gtIs after a specified date.{\"#gt\":{\"birthDate\":\"1987-07-10\"}}
#gteIs after or equal to a specified date.{\"#gte\":{\"birthDate\":\"1987-07-10\"}}
#inIs equal to one of dates in a given list.{\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}
#notInIs not equal to any of dates in a given list.{\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}
IntegersDescriptionExample
#eqEquals to a specified integer.{\"data\\u0001counter\":1}
#neNot equal to a specified integer.{\"#ne\":{\"data\\u0001counter\":1}}
#ltIs less than a specified integer.{\"#lt\":{\"data\\u0001counter\":1}}
#lteIs less than or equal to a specified integer.{\"#lte\":{\"data\\u0001counter\":1}}
#gtIs greater than a specified integer.{\"#gt\":{\"data\\u0001counter\":1}}
#gteIs greater than or equal to a specified integer.{\"#gte\":{\"data\\u0001counter\":1}}
#inIs equal to any of specified integers in a list.{\"#in\":{\"data\\u0001counter\":[1,2,3]}}
#notInIs not equal to any of specified integers in a list.{\"#notIn\":{\"data\\u0001counter\":[1,2,3]}}
DecimalsDescriptionExample
#eqEquals to a specified decimal.{\"data\\u0001price\":1.1}
#neIs not equal to a specified decimal.{\"#ne\":{\"data\\u0001price\":1.1}}
#ltIs less than a specified decimal.{\"#lt\":{\"data\\u0001price\":1.1}}
#lteIs less than or equal to a specified decimal.{\"#lte\":{\"data\\u0001price\":1.1}}
#gtIs greater than a specified decimal.{\"#gt\":{\"data\\u0001price\":1.1}}
#gteIs greater than or equal to a specified decimal.{\"#gte\":{\"data\\u0001price\":1.1}}
#inIs equal to any of specified decimals in a list.{\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}}
#notInIs not equal to any of specified decimals in a list.{\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}}
BooleansDescriptionExample
#eqEquals to a specified boolean.{\"data\\u0001happy\":true}
#neNot equal to a specified boolean.{\"#ne\":{\"data\\u0001happy\":true}}
TagsDescriptionExample
#containsContains a specified tag.{\"#contains\":{\"tags\":\"SOME_TAG\"}}
#notContainDoes not contain a specified tag.{\"#notContain\":{\"tags\":\"SOME_TAG\"}}
GenderDescriptionExample
#eqEquals a specified gender.{\"gender\":\"MALE\"}
#neDoes not equal a specified gender.{\"#ne\":{\"gender\":\"FEMALE\"}}
ListsDescriptionExample
#allAll items in the list match.{\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}\n
#anyAny item in the list match.{\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}\n
\n\n", "example":{ "#and":[ { "firstName":"Alex" }, { "#contains":{ "tags":"VIP Client" } } ] } }, "events":{ "type":"array", "description":"List of events that persons should match.", "items":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto" } }, "createdAt":{ "type":"string", "format":"date-time", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." }, "modifiedAt":{ "type":"string", "format":"date-time", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.SSSZ." } }, "required":[ "id", "name" ], "title":"SegmentResponseDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.SegmentUpdateDto":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"A unique segment name.", "example":"VIP Alex Clients" }, "description":{ "type":"string", "description":"Segment description.", "example":"Persons named Alex with tag \"VIP Client\"" }, "query":{ "type":"object", "additionalProperties":{ "type":"object", "example":{ "#and":[ { "firstName":"Alex" }, { "#contains":{ "tags":"VIP Client" } } ] } }, "description":"\nAllows to filter persons using simple queries.\n\n##### Supported logical operators\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
OperatorDescriptionExample
#andAll records that match the conditions of all clauses.{\"#and\":[{\"firstName\":\"John\"},{\"lastName\":\"Smith\"}]}
#orAll records that match the conditions of any clause.{\"#or\":[{\"firstName\":\"John\"},{\"firstName\":\"Jane\"}]}
\n\n##### Supported comparison operators\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
AttributesDescriptionExample
#notExistMatches records that do not have given attribute.{\"#notExist\":\"firstName\"}
#existMatches records that have given attribute.{\"#exists\":\"firstName\"}
StringsDescriptionExample
#eqEquals to a specified string.{\"firstName\":\"John\"}
#neNot equal to a specified string.{\"#ne\":{\"firstName\":\"John\"}}
#startsWithStarts with a specified string.{\"#startsWith\":{\"firstName\":\"John\"}}
#endsWithEnds with a specified string.{\"#endsWith\":{\"firstName\":\"John\"}}
#containsContains a specified string.{\"#contains\":{\"firstName\":\"oh\"}}
#notContainDoes not contain a specified string.{\"#notContain\":{\"firstName\":\"oh\"}}
#inAt least one of the strings in a list.{\"#in\":{\"firstName\":[\"John\",\"Jane\"]}}
#notInNot any of the strings in a list.{\"#notIn\":{\"firstName\":[\"John\",\"Jane\"]}}
DatesDescriptionExample
#eqEquals to a specified date.{\"birthDate\":\"1987-07-10\"}
#neNot equal to a specified date.{\"#ne\":{\"birthDate\":\"1987-07-10\"}}
#eq (relative)Will be in specified interval.{\"#eq\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#lt (relative)Will be within a specified interval.{\"#lt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#gt (relative)Will be in more than a specified interval.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P1D\"}}}
#eq (relative) -Was a specified interval ago.{\"#eq\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#gt (relative) -Was within a specified interval ago.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#gt (relative) -Was more than a specified interval ago.{\"#gt\":{\"birthDate\":{\"#relNow\":\"P-1D\"}}}
#ltIs before a specified date.{\"#lt\":{\"birthDate\":\"1987-07-10\"}}
#lteIs before or equal to a specified date.{\"#lte\":{\"birthDate\":\"1987-07-10\"}}
#gtIs after a specified date.{\"#gt\":{\"birthDate\":\"1987-07-10\"}}
#gteIs after or equal to a specified date.{\"#gte\":{\"birthDate\":\"1987-07-10\"}}
#inIs equal to one of dates in a given list.{\"#in\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}
#notInIs not equal to any of dates in a given list.{\"#notIn\":{\"birthDate\":[\"1987-07-10\",\"1987-07-11\"]}}
IntegersDescriptionExample
#eqEquals to a specified integer.{\"data\\u0001counter\":1}
#neNot equal to a specified integer.{\"#ne\":{\"data\\u0001counter\":1}}
#ltIs less than a specified integer.{\"#lt\":{\"data\\u0001counter\":1}}
#lteIs less than or equal to a specified integer.{\"#lte\":{\"data\\u0001counter\":1}}
#gtIs greater than a specified integer.{\"#gt\":{\"data\\u0001counter\":1}}
#gteIs greater than or equal to a specified integer.{\"#gte\":{\"data\\u0001counter\":1}}
#inIs equal to any of specified integers in a list.{\"#in\":{\"data\\u0001counter\":[1,2,3]}}
#notInIs not equal to any of specified integers in a list.{\"#notIn\":{\"data\\u0001counter\":[1,2,3]}}
DecimalsDescriptionExample
#eqEquals to a specified decimal.{\"data\\u0001price\":1.1}
#neIs not equal to a specified decimal.{\"#ne\":{\"data\\u0001price\":1.1}}
#ltIs less than a specified decimal.{\"#lt\":{\"data\\u0001price\":1.1}}
#lteIs less than or equal to a specified decimal.{\"#lte\":{\"data\\u0001price\":1.1}}
#gtIs greater than a specified decimal.{\"#gt\":{\"data\\u0001price\":1.1}}
#gteIs greater than or equal to a specified decimal.{\"#gte\":{\"data\\u0001price\":1.1}}
#inIs equal to any of specified decimals in a list.{\"#in\":{\"data\\u0001price\":[1.1,2.1,3.0]}}
#notInIs not equal to any of specified decimals in a list.{\"#notIn\":{\"data\\u0001price\":[1.1,2.1,3.0]}}
BooleansDescriptionExample
#eqEquals to a specified boolean.{\"data\\u0001happy\":true}
#neNot equal to a specified boolean.{\"#ne\":{\"data\\u0001happy\":true}}
TagsDescriptionExample
#containsContains a specified tag.{\"#contains\":{\"tags\":\"SOME_TAG\"}}
#notContainDoes not contain a specified tag.{\"#notContain\":{\"tags\":\"SOME_TAG\"}}
GenderDescriptionExample
#eqEquals a specified gender.{\"gender\":\"MALE\"}
#neDoes not equal a specified gender.{\"#ne\":{\"gender\":\"FEMALE\"}}
ListsDescriptionExample
#allAll items in the list match.{\"#all\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}\n
#anyAny item in the list match.{\"#any\":{\"data\\u0001Cart\":{\"#and\":[{\"ProductName\":\"Laptop\"},{\"ProductPrice\":2000}]}}}\n
\n\n", "example":{ "#and":[ { "firstName":"Alex" }, { "#contains":{ "tags":"VIP Client" } } ] } }, "events":{ "type":"array", "description":"List of events that persons should match.", "items":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.EventClauseDto" } } }, "required":[ "name" ], "title":"SegmentUpdateDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionDto":{ "type":"object", "description":"Specify in which timespan did the event occur.", "properties":{ "occurred":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOccurred" }, "operator":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOperator" }, "start":{ "type":"integer", "format":"int32", "description":"Start of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp.", "example":60 }, "end":{ "type":"integer", "format":"int32", "description":"End of timespan: For relative operators, specify the number of units. For absolute operators, provide a Unix timestamp.", "example":30 }, "units":{ "$ref":"#/components/schemas/d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionUnits" } }, "required":[ "occurred", "operator" ], "title":"TimelineConditionDto" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOccurred":{ "type":"string", "description":"Specifies whether an event is occurring for the first or last time within a given period. Additionally, we can use an operator to specify if any event has occurred or never occurred within the specified timeframe.", "enum":[ "ALL", "FIRST", "LAST", "NOT" ], "example":"ALL", "title":"TimelineConditionOccurred" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionOperator":{ "type":"string", "description":"The operators AFTER, BEFORE, and BETWEEN can be used to specify relative time periods, while their counterparts with the suffix _ABS (e.g., AFTER_ABS, BEFORE_ABS, BETWEEN_ABS) are used for absolute time values. These operators can be applied with start and end attributes to define the beginning and ending points of the time. Units need to be used with relative operators to specify the duration of the time periods.", "enum":[ "EMPTY", "AFTER", "BEFORE", "BETWEEN", "AFTER_ABS", "BEFORE_ABS", "BETWEEN_ABS" ], "example":"BETWEEN", "title":"TimelineConditionOperator" }, "d76a8e2b7d80b5cb0751e11a31b96eabeaf6b2ec1de2932507f7f2749e61e91c.TimelineConditionUnits":{ "type":"string", "description":"Time units for relative operators.", "enum":[ "DAYS", "HOURS", "MINUTES" ], "example":"DAYS", "title":"TimelineConditionUnits" }, "f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.CompaniesResponse":{ "type":"object", "properties":{ "companies":{ "type":"array", "description":"List of companies.", "items":{ "$ref":"#/components/schemas/f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2" }, "readOnly":false, "writeOnly":false }, "limit":{ "type":"integer", "format":"int32", "description":"Limit how many rows will be returned (but possibly less, if the query itself yields fewer rows)", "readOnly":false, "writeOnly":false }, "orderBy":{ "type":"string", "description":"Results ordering", "readOnly":false, "writeOnly":false }, "page":{ "type":"integer", "format":"int32", "description":"Page number", "readOnly":false, "writeOnly":false }, "totalCount":{ "type":"integer", "format":"int64", "description":"Total amount of rows", "readOnly":true, "writeOnly":false } }, "title":"CompaniesResponse" }, "f1f4d23441e1a2e5d9e00e8bea59bdb50b3ee0c91558c0dac55f3a711b5f2d3f.IamCompanyV2":{ "type":"object", "properties":{ "accountManager":{ "type":"string", "description":"Account manager.", "maxLength":255, "minLength":0, "readOnly":false, "writeOnly":false }, "country":{ "type":"string", "description":"Country.", "maxLength":50, "minLength":0, "readOnly":false, "writeOnly":false }, "createdAt":{ "type":"string", "description":"Date and time of creation. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "customAttributes":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"List of custom attributes for the company.", "readOnly":false, "writeOnly":false }, "customerStage":{ "type":"string", "description":"Customer stage.", "maxLength":255, "minLength":0, "readOnly":false, "writeOnly":false }, "domains":{ "type":"array", "description":"List of domains for the company.", "items":{ "type":"string" }, "readOnly":false, "writeOnly":false }, "externalId":{ "type":"string", "description":"Unique ID for a company from your or another external system, 256 characters max", "readOnly":false, "writeOnly":false }, "id":{ "type":"integer", "format":"int64", "description":"Unique id of the entity.", "readOnly":true, "writeOnly":false }, "industry":{ "type":"string", "description":"Industry.", "maxLength":255, "minLength":0, "readOnly":false, "writeOnly":false }, "modifiedAt":{ "type":"string", "description":"Date and time of last modification. Has the following format: yyyy-MM-dd'T'HH:mm:ss.", "readOnly":true, "writeOnly":false }, "modifiedFrom":{ "allOf":[ { "$ref":"#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin" } ], "description":"The information which describes the source of the last modification of record.", "readOnly":true, "writeOnly":false }, "name":{ "type":"string", "description":"Company name.", "maxLength":255, "minLength":0, "readOnly":false, "writeOnly":false }, "notes":{ "type":"string", "description":"Notes.", "maxLength":1023, "minLength":0, "readOnly":false, "writeOnly":false }, "origin":{ "allOf":[ { "$ref":"#/components/schemas/bd4ede8ed45be5abed1981f01dd3d5e59730966bed7e4695994e920454030b86.IamOrigin" } ], "description":"The information which describes the origin of the record.", "readOnly":true, "writeOnly":false }, "region":{ "type":"string", "description":"Region.", "maxLength":255, "minLength":0, "readOnly":false, "writeOnly":false }, "segment":{ "type":"string", "description":"Segment.", "maxLength":255, "minLength":0, "readOnly":false, "writeOnly":false }, "serviceData":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Company's service information.", "readOnly":false, "writeOnly":false }, "tags":{ "type":"array", "description":"List of tags for the company.", "items":{ "type":"string" }, "readOnly":false, "writeOnly":false }, "vatNumber":{ "type":"string", "description":"VAT number.", "maxLength":50, "minLength":0, "readOnly":false, "writeOnly":false } }, "required":[ "name" ], "title":"IamCompanyV2" }, "f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.BatchPersonsToCompanyRequest":{ "type":"object", "properties":{ "people":{ "type":"array", "description":"List of people.", "items":{ "$ref":"#/components/schemas/f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.PersonsToCompanyEntry" }, "readOnly":false, "writeOnly":false } }, "title":"BatchPersonsToCompanyRequest" }, "f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.CompanyIdentityQuery":{ "type":"object", "properties":{ "id":{ "type":"string", "description":"Company ID", "readOnly":false, "writeOnly":false }, "externalId":{ "type":"string", "description":"Company external ID", "readOnly":false, "writeOnly":false }, "name":{ "type":"string", "description":"Company name", "readOnly":false, "writeOnly":false }, "domain":{ "type":"string", "description":"Company domain", "readOnly":false, "writeOnly":false } }, "title":"CompanyIdentityQuery" }, "f844b0afac35672d98ce1343ef10d571c4af0fe8a10110acace5c340f3fe0877.PersonsToCompanyEntry":{ "type":"object", "properties":{ "query":{ "allOf":[ { "$ref":"#/components/schemas/d4672690671974f6265c4d7a3cef5f9272fe4290e9edb608eab676ae3febd3a1.IdentityQuery" } ] } }, "title":"PersonsToCompanyEntry" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderDirection":{ "type":"string", "description":"Sort direction for results.", "enum":[ "Asc", "Desc" ], "title":"DefinitionOrderDirection" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.DefinitionOrderField":{ "type":"string", "description":"Field by which results should be ordered.", "enum":[ "DefinitionId", "Title" ], "title":"DefinitionOrderField" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionCategory":{ "type":"string", "description":"Event definition category.", "enum":[ "external", "person", "channel", "product", "template" ], "title":"EventDefinitionCategory" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventDefinitionSubcategory":{ "type":"string", "description":"Event definition subcategory.", "enum":[ "sms", "email", "push", "whatsapp", "viber", "facebook", "moments", "forms", "conversations", "mobileapp", "voice", "line", "appleBC", "rcs", "mms", "viberBot", "inapp", "answers", "blocklist" ], "title":"EventDefinitionSubcategory" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventFieldType":{ "type":"string", "description":"Field data type.", "enum":[ "String", "Boolean", "DateTime", "Numeric", "Decimal", "List" ], "title":"EventFieldType" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.EventResourceRequest":{ "type":"object", "properties":{ "eventId":{ "type":[ "string", "null" ], "description":"Unique identifier of the event. If provided, it helps prevent duplicate events in case of retries—for example, if the first API call fails and the same event is sent again. Passing the same `eventId` ensures the event is only recorded once in the person profile.
The value must be `1–36` characters long and can include letters `(A–Z, a–z)`, digits `(0–9)`, underscores `(_)`, and hyphens `(-)` only." }, "properties":{ "type":[ "object", "null" ], "additionalProperties":{ "type":"object" }, "description":"Object containing event properties. Must match the corresponding event definition. See People Events [documentation](https://www.infobip.com/docs/people/events#properties-custom-events) for supported data types." } }, "title":"EventResourceRequest" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemFieldType":{ "type":"string", "description":"Field data type within a List item.", "enum":[ "String", "Boolean", "DateTime", "Numeric", "Decimal" ], "title":"ListItemFieldType" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.ListItemType":{ "type":"string", "description":"Schema type for List items.", "enum":[ "Object" ], "title":"ListItemType" }, "fadcd3a5e2560b383cc614bf34d902f536c2b4a12ddd61a5d337e7d4f40ab864.PersonUniqueFieldType":{ "type":"string", "enum":[ "ID", "EXTERNAL_ID", "PHONE", "EMAIL", "LINE", "FACEBOOK", "TELEGRAM", "PUSH", "WEB_PUSH", "LIVE_CHAT", "VIBER_BOTS", "INSTAGRAM", "INSTAGRAM_DM", "TWITTER", "APPLE_BUSINESS_CHAT", "KAKAO_SANGDAM", "GOOGLE_BUSINESS_MESSAGES", "WHATSAPP", "ZALO_FOLLOWER", "TIKTOK_BM" ], "title":"PersonUniqueFieldType" }, "ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResponse":{ "type":"object", "properties":{ "results":{ "type":"array", "description":"List of any unsuccessful result from the batch operation for each processed entry. Example, name used in the request already exists.", "items":{ "$ref":"#/components/schemas/ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResult" }, "readOnly":false, "writeOnly":false } }, "title":"BatchUpdateResponse" }, "ff83b7738574b83363504f874ac9acc399c4aa8206175a6d6d0b7864a951905a.BatchUpdateResult":{ "type":"object", "properties":{ "errors":{ "type":"array", "description":"List of errors", "items":{ "$ref":"#/components/schemas/3206ab1528b990358dc5d8da723b52b5db6e1d582712d39b5ed66ac5c4b1e84f.BatchOperationError" }, "readOnly":false, "writeOnly":false }, "query":{ "type":"object", "additionalProperties":{ "type":"object" }, "description":"Query used for company identification", "readOnly":false, "writeOnly":false }, "status":{ "type":"integer", "format":"int32", "description":"HTTP status", "readOnly":false, "writeOnly":false } }, "title":"BatchUpdateResult" } }, "responses":{ "ApiError400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E400", "description":"Request cannot be processed.", "action":"Check the syntax, violations and adjust the request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E400\n Request cannot be processed.\n Check the syntax, violations and adjust the request.\n \n \n\n" } } }, "ApiError401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E401", "description":"The request lacks valid authentication credentials for the requested resource.", "action":"Check the resources and adjust authentication credentials.", "violations":[], "resources":[ { "name":"API Authentication", "url":"https://www.infobip.com/docs/essentials/api-authentication" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E401\n The request lacks valid authentication credentials for the requested resource.\n Check the resources and adjust authentication credentials.\n \n \n \n API Authentication\n https://www.infobip.com/docs/essentials/api-authentication\n \n \n\n" } } }, "ApiError403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E403", "description":"Insufficient permissions to access the requested resource.", "action":"Repeat the request with new or different credentials.", "violations":[], "resources":[ { "name":"API Scopes", "url":"https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E403\n Insufficient permissions to access the requested resource.\n Repeat the request with new or different credentials.\n \n \n \n API Scopes\n https://www.infobip.com/docs/essentials/api-essentials/api-authorization#api-scopes\n \n \n\n" } } }, "ApiError404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E404", "description":"Not found - request URL doesn't exist on the API server or resource is not found.", "action":"Check the resources and adjust your request.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E404\n Not found - request URL doesn't exist on the API server or resource is not found.\n Check the resources and adjust your request.\n \n \n\n" } } }, "ApiError429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E429", "description":"Too many requests sent.", "action":"Check request rate limit specified in the API endpoint documentation resource.", "violations":[], "resources":[ { "name":"Throttling handling errors", "url":"https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors" } ] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E429\n Too many requests sent.\n Check request rate limit specified in the API endpoint documentation resource.\n \n \n \n Throttling handling errors\n https://www.infobip.com/docs/essentials/integration-best-practices#throttling-handling-errors\n \n \n\n" } } }, "ApiError500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":{ "errorCode":"E500", "description":"Something went wrong.", "action":"Contact the support.", "violations":[], "resources":[] } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiError" }, "example":"\n E500\n Something went wrong.\n Contact the support.\n \n \n\n" } } }, "ApiException400":{ "description":"Bad Request", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"BAD_REQUEST", "text":"Bad request" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n BAD_REQUEST\n Bad request\n \n \n\n" } } }, "ApiException401":{ "description":"Unauthorized", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"UNAUTHORIZED", "text":"Unauthorized" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n UNAUTHORIZED\n Unauthorized\n \n \n\n" } } }, "ApiException403":{ "description":"Forbidden", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"FORBIDDEN", "text":"Forbidden" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n FORBIDDEN\n Forbidden\n \n \n\n" } } }, "ApiException404":{ "description":"Not Found", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"NOT_FOUND", "text":"Not found" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n NOT_FOUND\n Not found\n \n \n\n" } } }, "ApiException429":{ "description":"Too Many Requests", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"TOO_MANY_REQUESTS", "text":"Too many requests" } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n TOO_MANY_REQUESTS\n Too many requests\n \n \n\n" } } }, "ApiException500":{ "description":"Internal Server Error", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":{ "requestError":{ "serviceException":{ "messageId":"GENERAL_ERROR", "text":"Something went wrong. Please contact support." } } } }, "application/xml":{ "schema":{ "$ref":"#/components/schemas/ApiException" }, "example":"\n \n \n GENERAL_ERROR\n Something went wrong. Please contact support.\n \n \n\n" } } } }, "parameters":{}, "examples":{}, "requestBodies":{}, "headers":{}, "securitySchemes":{ "APIKeyHeader":{ "type":"apiKey", "description":"This is the most secure authorization type and the one with the most flexibility.\n\nAPI 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\nbe 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.\nFinally, the loss of an API key is easily manageable.\n\nYou can manage your API keys from [GUI](https://portal.infobip.com/settings/accounts/api-keys), or programmatically\nwith [dedicated API](#platform-&-connectivity/settings).\n\nAPI key Authorization header example:\n\n```shell\nAuthorization: App 003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9\n```\n", "name":"Authorization", "in":"header" }, "Basic":{ "type":"http", "description":"Basic authorization type can be used in situations when the API key is not available. For example, API methods for generating API keys should be authenticated\nwith the Basic type.\n\nIn this case, the credentials included in the Authorization header should be a Base64 encoded username and password combination. More formally, basic\nauthentication header can be constructed in three steps:\n\n* Username and password are concatenated using the colon `(:)` as a separator `username:password`.\n* The resulting string is encoded using the [RFC2045-MIME](https://www.ietf.org/rfc/rfc2045.txt) variant of Base64.\n* Encoded string is added as credentials after the `\"Basic \"` type.\n\nExample:\n\n```shell\nUsername: \"Aladdin\"\nPassword: \"openSesame\"\n\nConcatenated string: \"Aladdin:openSesame\"\n\nBase64 encoded string: \"QWxhZGRpbjpvcGVuU2VzYW1l\"\n\nAuthorization header: \"Basic QWxhZGRpbjpvcGVuU2VzYW1l\"\n```\n\n> **Implementation detail**: Base64 encoding is a standard and many available programming languages and frameworks provide convenient methods for encoding\n> strings.\n", "scheme":"basic" }, "IBSSOTokenHeader":{ "type":"apiKey", "description":"This authorization type is suited for situations when you do not want to store Infobip credentials in your own app. Instead, your users will input their Infobip\ncredentials every time they access your application and the application will use those credentials to create a session. From then on, the session token can be\nused to authenticate subsequent API requests. Note that the session will expire automatically after a predefined period of inactivity, and can also be manually\nterminated by making an appropriate API call.\n\nYou can find more details on the creation and behavior of the session at\nthe [dedicated documentation page](#platform-connectivity/account-management/create-session).\n\nAfter obtaining the session token by calling the above-referenced API method you can include it in the Authorization header like this:\n\n```shell\nAuthorization: IBSSO 2f9b4d31-2d0d-49a8-85f0-9b862bdca394\n```\n", "name":"Authorization", "in":"header" }, "OAuth2":{ "type":"oauth2", "description":"Similarly to the IBSSO Token authentication you can use OAuth 2.0 bearer token with Infobip serving both as resource and authorization server. You can obtain\nthe access token using the client credentials grant from `auth/1/oauth2/token` endpoint. It will provide you with your access token, and its expiration period.\nYou can use the token to authorize your API calls until it expires. You can find out more about the process in\nthe [official specification](https://tools.ietf.org/html/rfc6749#section-4.4).\n\nYou can include your access token in the Authorization HTTP request header like this:\n\n```http\nAuthorization: Bearer \n```", "flows":{ "clientCredentials":{ "tokenUrl":"https://api.infobip.com/auth/1/oauth2/token", "scopes":{} } } } }, "links":{}, "callbacks":{} } }