---
title: "Personalize push instance"
method: POST
path: "/people/2/contactInformation/push/{pushRegId}/personalize"
tags: ["customer-engagement", "people", "contact-information:-push"]
---

# Personalize push instance

`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)
- URL: `https://api.infobip.com/people/2/contactInformation/push/{pushRegId}/personalize`
- Auth: one of:
  - OAuth 2
    - Client credentials
    - Token URL: `https://api.infobip.com/auth/1/oauth2/token`
  - API key in header `Authorization`
  - API key in header `Authorization`
  - HTTP basic

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.

## Path parameters

- `pushRegId` string, required

## Query parameters

- `forceDepersonalize` boolean
- `keepAsLead` boolean
- `returnPush` boolean
- `setDeviceAsPrimary` boolean

## Headers

- `AppCode` string, required

## Request body

- 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8PushUserPersonalizationRequest
  - `identity` 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8PushUserIdentity, required: Unique identifiers from this object will be used to find a person to personalize push registration with
    - `externalId` string: 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` string: User email
    - `phoneNumber` string: User phone number according to E.164 general format
  - `attributes` object: Data specified in this object will be applied to the target person upon personalization
    - `firstName` string: User first name
    - `lastName` string: User last name
    - `middleName` string: User middle name
    - `birthday` string, date-time
    - `gender` 'MALE' | 'FEMALE': User gender
    - `customAttributes` object: Set of custom key-value pairs where value can be any of `string`, `number`, `boolean`
    - `tags` string[]: Set of string labels attached to the user

## Response `200`

OK

- 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8PushUserPersonalizationResponse
  - `externalId` string: Id of a user in external system
  - `firstName` string: User first name
  - `lastName` string: User last name
  - `middleName` string: User middle name
  - `birthday` string, date-time
  - `gender` 'MALE' | 'FEMALE': User gender
  - `customAttributes` object: Set of custom key-value pairs where value can be any of `string`, `number`, `boolean`
  - `tags` string[]: Set of string labels attached to the user
  - `contactInformation` 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8ContactInformation
    - `phones` 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8ContactInformationPhone[]
      - `number` string
    - `emails` 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8ContactInformationEmail[]
      - `address` string
    - `push` 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8PushApiInstance[]
      - `registrationId` string, required: Push registration id of the instance
      - `applicationId` string, required: String id of the application that the instance belongs to
      - `isPrimary` boolean: Set to `true` if this device is a primary device of a user among other devices
      - `additionalData` object: Custom attributes set for a device
      - `systemData` 0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8PushApiInstanceSystemData: Set of push-specific attributes
        - `cloudType` 'GCM' | 'APNS' | 'HMS' | 'WEB': Push registration id of the instance
        - `registrationEnabled` boolean: State of the device registration
        - `notificationsEnabled` boolean: Set to `true` if notifications are enabled on a device
        - `geofencingSdk` boolean: 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.**
        - `sdkVersion` string: SDK version that is running on a device
        - `appVersion` string: The version of the application which SDK is embedded into
        - `os` 'Android' | 'iOS': Operating system type can be `Android` or `iOS`
        - `osVersion` string: The version of the operating system
        - `deviceManufacturer` string: The manufacturer of the device as detected by the SDK
        - `deviceModel` string: The model of the device
        - `deviceSecure` boolean: Set to `true` if the device has any type of secure screen lock set up
        - `osLanguage` string: An identifier of the language used on a device
        - `deviceTimezoneOffset` string: UTC-related timezone offset that identifies a current timezone of a device
        - `deviceName` string: The name of the device as configured by a user

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/infobip/apis/infobip-openapi-specification.md) - [All operations](https://skmtc.dev/infobip/apis/infobip-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/infobip/apis/infobip-openapi-specification/revisions/9dcbbaf902de?raw)