People

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.

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.

Use this method to create a new person.

Use this method to delete a person.

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.

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.

Use this method to delete specified emails and mobile phones from a particular person.

Use this method to add emails and mobile phones to a particular person.

Use this method to create multiple persons.
NOTE Array size of the batch create request is limited to 1000 persons.

Use this method to delete multiple persons.
NOTE Array size of the batch delete request is limited to 1000 persons.

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.

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.

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.

Use this method to create a new company.

Use this method with a query parameter to delete a company. Exactly one of the query parameters must be included in the query.

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.

Use this method to create multiple companies.
NOTE Array size of the batch create request is limited to 1000 companies.

Use this method to delete multiple companies.
NOTE Array size of the batch delete request is limited to 1000 companies.

Use this method to update multiple companies.
NOTE Array size of the batch update request is limited to 1000 companies.

Use this method to remove persons from a company.
NOTE Array size is limited to 1000 persons.

Use this method to add persons to a company.
NOTE Array size is limited to 1000 persons.

Use this method to get a list of tags with pagination.

Use this method to create a new tag.

Use this method to get a single tag.

Use this method to delete the existing tag.

This method allows you to remove tag from multiple people.
NOTE Array size of the batch remove request is limited to 1000 people.

This method allows you to assign tag to multiple people.
NOTE Array size of the batch add request is limited to 1000 people.

Get a list of custom attributes using this method.

Create a new custom attribute by using this method.

Get a single custom attribute using this method.

Use this method to delete the custom attribute

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.

Get a single item or a list of items of a list attribute.

Adds new items to a list attribute and returns all items of the updated list.

Deletes items in a list attribute and returns all items of the updated list.

Replaces an item of a list attribute and returns all items of the updated list.

Updates the fields of a list item that are passed in the request. Missing fields will keep their values. Returns all items of the updated list attribute.

Returns all items of a single or multiple list attributes.

Deletes a single or multiple list attributes of a profile.

Replaces all items in a list attribute and returns all items of the updated list.

Updates the fields of list items passed in the request. Missing items and fields will keep their values. Returns all items of the updated list.

Use this method to get device data

Use this method to update device data

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

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.

A method to send new event and its properties related to a specific person. Event must be related to existing person and definition.

Use this endpoint to track events that persons perform. Your request must refer to existing person profile and event definition.

Events export allows you to asynchronously export People Events data to a compressed file or multiple files in your AWS S3 bucket.

Refer to product documentation for detailed information on configuring AWS S3 for export, export file format and event data schema.

Throttling

You can have maximum of 72 hours worth of export requests in progress at one time.

Retrieves the status of a previously submitted data export request by the request ID.

Requests asynchronous cancellation of a previously submitted data export request by the request ID.

Retrieves a list of all available event definitions, including custom events. The event definitions can be then used as a filter in the Event Export API.

Use this method to get a list of segments.

Use this method to create a segment.

Use this method to get a segment by ID.

Use this method to update a segment.

Use this method to delete a segment by ID.