customer-engagement
people
contact-information:-push

Personalize push instance

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.

post/people/2/contactInformation/push/{pushRegId}/personalize

Request

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

Path parameters

pushRegIdstring required

Registration identifier of a particular push device registration

Query parameters

forceDepersonalizeboolean

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.

keepAsLeadboolean

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.

returnPushboolean

You can set this parameter to true if you want the response to include "push" mobile app contact information for the person.

setDeviceAsPrimaryboolean

You can set this parameter to true if you want to set the device associated with the "pushRegId" as primary device for the person.

Headers

AppCodestring required

Application code

Request body

Response

OK

externalIdstring

Id of a user in external system

firstNamestring

User first name

lastNamestring

User last name

middleNamestring

User middle name

birthdaystring date-time
gender'MALE' | 'FEMALE'

User gender

customAttributesobject

Set of custom key-value pairs where value can be any of string, number, boolean

tagsstring[]

Set of string labels attached to the user

Changes

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