> ## Documentation Index
> Fetch the complete documentation index at: https://developers.phonovation.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Personalize push instance
> Each person can have Phone numbers, Emails or External ID. These fields are unique identifiers of a person on Phonovation 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 Phonovation platform.
**Required scope:** Enable one of: `people:manage`, `mobile-app-messaging:manage`.
## OpenAPI
````yaml /openapi/phonovation-whatsapp.json post /people/2/contactInformation/push/{pushRegId}/personalize
openapi: 3.1.0
info:
title: Phonovation Messaging APIs
description: >-
OpenAPI specification for Phonovation messaging, customer engagement, and
platform APIs.
contact:
name: Phonovation support
email: support@phonovation.com
version: 3.250.0
x-generatedAt: '2026-10-15T11:28:56.135064395Z'
servers:
- url: https://api.messaging.phonovation.com
description: Phonovation Messaging API production server
security: []
tags:
- name: customer-engagement
description: >
Complete solutions that will help you drive better outcomes for your
customers and business across the entire customer journey.
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.
Events reflect actions that end users take on your website or in your
mobile application.
Events API is a robust way to send those events to Phonovation. 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.
Other events tracking options:
* [ JavaScript SDK ](https://github.com/phonovation/people-web-sdk)
* [iOS
SDK](https://github.com/phonovation/mobile-messaging-sdk-ios/wiki/Events)
* [Android
SDK](https://github.com/phonovation/mobile-messaging-sdk-android/wiki/Events)
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
- name: moments
description: >
Use Moments to set up and manage automated messaging campaigns with your
customers by building conversation workflows.
x-type: product
x-displayName: Moments
- name: flow
description: >
[Flow](https://www.phonovation.com/docs/moments/manage-flow) is the
Phonovation communication builder that helps you create and manage
messaging campaigns. The Flows API allows you to add or remove people from
communication programmatically for flows with an [active
status](https://www.phonovation.com/docs/moments/manage-flow#launch-create).
Use the Add Participants to flow endpoint to a person or batches of
persons (between 1-1000 persons). The method works asynchronously to queue
and process participants at a rate of 10 requests per second. For
reporting of operation results, use the notifyUrl field to provide a URL
of your callback server that will receive a status report or use the Get a
report on participants added to Flow endpoint.
x-type: module
x-displayName: Flow
- name: conversations
description: >-
Conversations is a solution that allows Enterprises to engage in
conversations with their customers over multiple channels. The solution is
available either as a web-based cloud platform web interface or over HTTP
API for 2-way messaging over SMS, WhatsApp, Viber, and Facebook messenger.
It supports conversation threading, conversation management including
queues and routing, agent assignment, resolution management and
conversation history overview.
x-type: product
x-displayName: Conversations
- name: conversation-management
description: ''
x-type: section
x-displayName: Conversation management
- name: conversation-tags
description: ''
x-type: section
x-displayName: Conversation tags
- name: conversation-messages
description: ''
x-type: section
x-displayName: Conversation messages
- name: conversation-events
description: ''
x-type: section
x-displayName: Conversation events
- name: conversation-notes
description: ''
x-type: section
x-displayName: Conversation notes
- name: conversation-agents
description: ''
x-type: section
x-displayName: Conversation agents
- name: conversation-queues
description: ''
x-type: section
x-displayName: Conversation queues
- name: conversation-routing
description: ''
x-type: section
x-displayName: Conversation routing
- name: bots
description: ''
x-type: section
x-displayName: Bots
- name: metadata
description: ''
x-type: section
x-displayName: Metadata
- name: templates
description: ''
x-type: section
x-displayName: Templates
- name: conversation-forms
description: ''
x-type: section
x-displayName: Conversation forms
- name: account-configuration
description: ''
x-type: section
x-displayName: Account Configuration
- name: agent-configuration-calls
description: ''
x-type: section
x-displayName: Agent Configuration (Calls)
- name: outbound-call-conversation-calls
description: ''
x-type: section
x-displayName: Outbound Call Conversation (Calls)
- name: waiting-strategies-calls
description: ''
x-type: section
x-displayName: Waiting Strategies (Calls)
- name: recording-configuration-calls
description: ''
x-type: section
x-displayName: Recording Configuration (Calls)
- name: recording-metadata-calls
description: ''
x-type: section
x-displayName: Recording metadata (Calls)
- name: recording-calls
description: ''
x-type: section
x-displayName: Recording (Calls)
- name: wrap-up-configuration-calls
description: ''
x-type: section
x-displayName: Wrap Up Configuration (Calls)
- name: wrap-up-time-calls
description: ''
x-type: section
x-displayName: Wrap Up Time (Calls)
- name: transfers-calls
description: ''
x-type: section
x-displayName: Transfers (Calls)
- name: transfer-to-external-number-configuration-calls
description: ''
x-type: section
x-displayName: Transfer to External Number Configuration (Calls)
- name: transfer-strategy-calls
description: ''
x-type: section
x-displayName: Transfer Strategy (Calls)
- name: call-hold-calls
description: ''
x-type: section
x-displayName: Call Hold (Calls)
- name: hold-configuration-calls
description: ''
x-type: section
x-displayName: Hold Configuration (Calls)
- name: call-timeout-calls
description: ''
x-type: section
x-displayName: Call Timeout (Calls)
- name: working-hours
description: ''
x-type: section
x-displayName: Working Hours
- name: tts-options-calls
description: ''
x-type: section
x-displayName: TTS options (Calls)
- name: away-audio-messages
description: ''
x-type: section
x-displayName: Away Audio Messages
- name: web-forms
description: ''
x-type: section
x-displayName: Web Forms
- name: answers
description: >
Answers is the Phonovation fully-encompassed chatbot building platform
that enables you to build, test, and deploy highly customized chatbots of
different types. Multiple channels are supported on Answers like WhatsApp,
Facebook Messenger, Live Chat, Apple Business Chat, Viber, Google Business
Messaging and other. Communication with Bot is achieved through existing
Conversations solution infrastructure which enables integration and
switching between communicating with bot and a live agent. Processing can
start by receiving MO message or by receiving a trigger event. Users can
manage bots (create, update, delete, start and stop bots) through a web
interface. For more details, visit the [Answers
documentation](https://www.phonovation.com/docs/answers).
Answers API is in Early access stage.
x-type: product
x-displayName: Answers
- name: answers-testing-start-test
description: ''
x-type: section
x-displayName: Start Answers test
- name: answers-testing-stop-test
description: ''
x-type: section
x-displayName: Stop Answers test
- name: answers-testing-send-message
description: ''
x-type: section
x-displayName: Send inbound message to test
- name: common-assets
description: >
Reuse assets created on Phonovation SaaS products in order to recreate
configuration more easily on a single or across multiple accounts. Export
or share Moments flows, Answers chatbots or other SaaS assets from your
account and import it on another one.
This feature is in Early access stage.
x-type: product
x-displayName: Common Assets
- name: saas-resource-export
description: ''
x-type: section
x-displayName: Export resource
- name: saas-resource-import
description: ''
x-type: section
x-displayName: Import resource
- name: saas-resource-share
description: ''
x-type: section
x-displayName: Share resource
- name: saas-status-request
description: ''
x-type: section
x-displayName: Get SaaS request status
- name: knowledge-base
description: >-
Knowledge Base is a centralized content management system for creating,
organizing, and retrieving articles, attachments, and structured content.
Content is organized into categories, folders, and a hierarchical content
tree. Articles support draft and published workflow statuses, tagging,
commenting, and file attachments.
x-type: product
x-displayName: Knowledge Base
- name: knowledge-base-search
description: ''
x-type: section
x-displayName: Search
- name: knowledge-base-articles
description: ''
x-type: section
x-displayName: Articles
- name: knowledge-base-categories
description: ''
x-type: section
x-displayName: Categories
- name: knowledge-base-folders
description: ''
x-type: section
x-displayName: Folders
- name: knowledge-base-content-tree
description: ''
x-type: section
x-displayName: Content Tree
- name: knowledge-base-tags
description: ''
x-type: section
x-displayName: Tags
- name: knowledge-base-attachments
description: ''
x-type: section
x-displayName: Attachments
- name: ai-hub
description: >
AI-powered tools and services to help you create smarter and more
personalized customer experiences.
x-type: category
x-displayName: AI Hub
- name: ai-assistants
description: >
Phonovation AI assistant is a retrieval-augmented generation (RAG)
solution that performs tasks based on documents and
instructions you specify. This means the AI draws answers directly from
your documents, resulting in more accurate
and relevant responses. For more information on use cases and how to build
AI assistants, visit our
[AI Assistant](https://www.phonovation.com/docs/ai-hub/ai-assistant)
product documentation.
With AI Assistants API, you can:
* Query your existing AI assistants created via [Phonovation
Portal](https://www.phonovation.com/docs/ai-hub/ai-assistant/create-ai-assistant)
* Retrieve context the AI assistant uses to answer your queries
x-type: product
x-displayName: AI Assistants
- name: channels
description: >
Create a perfect customer experience by using the channels your customer
already use and love.
x-type: category
x-displayName: Channels
- name: sms
description: >
SMS (Short Message Service) is the most extensive messaging service
available in terms of reach and coverage. A SMS can be sent to and from
any mobile device in the world and does not necessarily require a data
connection.
Phonovation SMS API allows you to send and receive text messages (SMS),
fetch or receive delivery reports on your endpoint in real time, and see
message logs. You can send messages in different languages, schedule your
messages, define delivery time window, and much more.
To utilize SMS in combination with other channels, check out [Messages
API](https://www.phonovation.com/docs/api/platform/messages-api).
x-type: product
x-displayName: SMS
- name: outbound-sms
description: >
When you send an SMS to a phone number belonging to an end user's device
you are sending an Outbound SMS. Historically, this was and still is
referred to as a Mobile Terminated (MT) SMS, though nowadays an SMS is not
always sent to a mobile device. In an Outbound SMS you can set the From or
Sender field with whatever you have registered or purchased with
Phonovation, either a Long Number, Short Code, or text based Sender.
x-type: module
x-displayName: Outbound SMS
- name: send-message
description: ''
x-type: section
x-displayName: Send a message
- name: manage-scheduled-sms-messages
description: ''
x-type: section
x-displayName: Manage Scheduled SMS Messages
- name: confirm-conversion
description: ''
x-type: section
x-displayName: Confirm conversion
- name: inbound-sms
description: >
When an end user sends an SMS from their device to a Phone Number or Short
Code they have sent an Inbound SMS. The Inbound SMS is routed to the
Phonovation Platform and Phonovation in turn routes the SMS to its
Customer who has purchased that Phone Number or Short Code. Inbound SMS,
for historical reasons, are referred to as Mobile Originated (MO) SMS.
x-type: module
x-displayName: Inbound SMS
- name: logs-and-status-reports
description: >
Status Reports tell you what happened to the SMS you sent, whether it was
successfully delivered or failed to be delivered.
They also provide timestamps, network information if available, and on SMS
delivery failure, a status code indicating the reason.
Status Reports can be pushed in real-time to a Customer's webhook or can
be retrieved by an API call.
Logs provide similar information to Status Reports but are available to
query for 48hrs.
x-type: module
x-displayName: Logs and Status Reports
- name: whatsapp
description: >
With 2 billion users, WhatsApp is the most used application worldwide. It
enables you to reach more customers, sharing important and timely
notifications, as well as provide real-time customer support. Phonovation
is an official WhatsApp Business solution provider. Send and manage
WhatsApp messages over Phonovation's WhatsApp API.
To utilize WhatsApp in combination with other channels, check out
[Messages
API](https://www.phonovation.com/docs/api/platform/messages-api).
[Learn more about WhatsApp channel and use
cases](https://www.phonovation.com/docs/whatsapp).
x-type: product
x-displayName: WhatsApp
- name: whatsapp-outbound-messages
description: >
When you send a WhatsApp message to a phone number belonging to an end
user's device you are sending an outbound WhatsApp message.
There are several types of WhatsApp messages:
- Template message – use a pre-defined template to send text, images, videos, share location, documents, attach buttons, and configure SMS failover.
- Free-form text or media – use it only when contacted by the end user within a certain timeframe to send text, images, audio, video, stickers, share location, or contacts.
- Interactive messages – send a message that your end user can interact with, such as interactive buttons, lists, or product messages.
x-type: module
x-displayName: Outbound messages
- name: whatsapp-template-message
description: ''
x-type: section
x-displayName: Template Message
- name: whatsapp-text-and-media-messages
description: ''
x-type: section
x-displayName: Text and media messages
- name: send-whatsapp-interactive-messages
description: ''
x-type: section
x-displayName: Interactive messages
- name: whatsapp-events
description: ''
x-type: section
x-displayName: Events
- name: whatsapp-inbound-messages
description: >
When the end user sends a WhatsApp from their device to a phone number,
they have sent an inbound WhatsApp message.
The inbound message is routed to the Phonovation Platform and Phonovation
in turn routes the message to its customer who has registered the WhatsApp
sender.
Typical supporting features you’d use with inbound messages are:
- Marking messages as read to communicate to the end user that you have read their message.
- Downloading media and its metadata sent over by the end user.
x-type: module
x-displayName: Inbound messages
- name: whatsapp-receive-inbound-message
description: ''
x-type: section
x-displayName: Receive inbound message
- name: whatsapp-get-inbound-media
description: ''
x-type: section
x-displayName: Get inbound media
- name: whatsapp-mark-message-as-read
description: ''
x-type: section
x-displayName: Mark message as read
- name: whatsapp-message-status-reports
description: >
Status Reports tell you what happened to the WhatsApp message you sent,
whether it was successfully delivered or failed to be delivered, whether
it’s been seen.
Status Reports can be pushed in real time to a customer's webhook or can
be retrieved by an API call.
Logs provide similar information to Status Reports but are only available
to query for 48hrs.
There are a few reports you can set up for your WhatsApp messaging:
- Delivery Reports - In case of a failure, you’ll receive a timestamp with a delivery failure message and a status code indicating the reason behind it.
- Seen Reports – In case the message has been delivered successfully to the end user, this report will additionally inform you whether the message has been seen.
- Payments - It provides all updates to your payment transaction in real time. It's also possible to fetch current state of the payment transaction in any time.
x-type: module
x-displayName: Message Status Reports
- name: whatsapp-status-reports
description: ''
x-type: section
x-displayName: Status Reports
- name: whatsapp-payments
description: ''
x-type: section
x-displayName: Payments
- name: whatsapp-marketing-update
description: ''
x-type: section
x-displayName: Marketing Update
- name: whatsapp-service-management
description: >
As opposed to free-form messages, template messages can be sent and
delivered at any time.
Here, you can manage your templates, from template registration,
retrieving template statuses, to deleting existing templates.
With each WhatsApp message, you can send various types of media. Here, you
can manage your media and configure additional feature enhancing their
functionality.
Moreover you can fetch quality and business info of your senders.
x-type: module
x-displayName: Service Management
- name: whatsapp-template-management
description: ''
x-type: section
x-displayName: Template Management
- name: whatsapp-flow-management
description: ''
x-type: section
x-displayName: Flow Management
- name: whatsapp-media-management
description: ''
x-type: section
x-displayName: Media Management
- name: whatsapp-sender-management
description: ''
x-type: section
x-displayName: Sender Management
- name: whatsapp-bulk-sender-registration
description: ''
x-type: section
x-displayName: Bulk Sender Registration
- name: whatsapp-identity-management
description: >
Set up identity change, an add-on available for senders hosted by
Phonovation. This is supported for interactive buttons, interactive lists,
or an interactive product message.
Identity change allows you to increase your security by preventing
messages from being sent to unverified end users.
Once enabled for a sender, you would receive notifications when an end
user's WhatsApp account (MSISDN) has potentially been transferred to a
different user.
When a potential identity change has been detected, the outbound traffic
towards that end user is blocked until you verify the user outside the
channel and acknowledge the change.
Contact your Account Executive for more information.
x-type: module
x-displayName: Identity Management
- name: whatsapp-ad-conversions
description: >
The Conversions API for Business Messaging enables advertisers to
consolidate web, app, physical store, and business messaging events into a
single endpoint for Meta. With Phonovation, you can submit Purchase or
LeadSubmitted conversion events for WhatsApp.
x-type: module
x-displayName: Ad Conversions
- name: platform
description: |
Modular tools to scale and automate your business.
x-type: category
x-displayName: Platform
- name: subscriptions-api
description: >
Subscriptions are a way to manage notifications sent to your webhooks by
Phonovation.
It is a useful feature if you want to narrow down the list of events to be
notified about or specify different webhooks for different use cases.
It will also allow you to set up authentication settings for your
endpoint.
If you want to use mutual TLS for the webhook that receives notification
events from Phonovation, you can upload and manage a TLS certificate that
Phonovation will use when connecting to your server. The certificate
allows your server to verify that the request is really coming from
Phonovation. For details, see [Create and Manage
Certificates](https://www.phonovation.com/docs/cpaas-x/subscriptions-management/create-manage-subscriptions#create-and-manage-certificates).
x-type: product
x-displayName: Subscriptions Management
- name: subscription
description: ''
x-type: section
x-displayName: Subscription
- name: profile
description: ''
x-type: section
x-displayName: Profile
- name: security
description: ''
x-type: section
x-displayName: Security
- name: certificate
description: ''
x-type: section
x-displayName: Certificate
paths:
/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 Phonovation 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 Phonovation platform.
**Required scope:** Enable one of: `people:manage`,
`mobile-app-messaging:manage`.
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:
- APIKeyHeader: []
components:
schemas:
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
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.PushApiErrorResponse:
type: object
properties:
errorCode:
type: integer
format: int32
errorMessage:
type: string
required:
- errorCode
- errorMessage
title: PushApiErrorResponse
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.PushApiGender:
type: string
description: User gender
enum:
- MALE
- FEMALE
title: PushApiGender
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
ApiException:
type: object
properties:
requestError:
$ref: '#/components/schemas/ApiRequestError'
title: ApiException
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationPhone:
type: object
properties:
number:
type: string
title: ContactInformationPhone
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.ContactInformationEmail:
type: object
properties:
address:
type: string
title: ContactInformationEmail
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
ApiRequestError:
type: object
properties:
serviceException:
$ref: '#/components/schemas/ApiRequestErrorDetails'
title: ApiRequestError
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
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
items:
type: string
description: Validation errors.
description: Validation errors.
title: ApiRequestErrorDetails
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.CloudType:
type: string
description: Push registration id of the instance
enum:
- GCM
- APNS
- HMS
- WEB
readOnly: true
title: CloudType
0b965bbf4d30392749e4c8a67c9c9019687026499d9a24d369daabb6b31c98b8.OperatingSystem:
type: string
description: Operating system type can be `Android` or `iOS`
enum:
- Android
- iOS
readOnly: true
title: OperatingSystem
responses:
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: |
UNAUTHORIZED
Unauthorized
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: |
FORBIDDEN
Forbidden
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: |
NOT_FOUND
Not found
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: |
GENERAL_ERROR
Something went wrong. Please contact support.
securitySchemes:
APIKeyHeader:
type: apiKey
description: >
This is the most secure authorization type and the one with the most
flexibility.
API 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
be 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.
Finally, the loss of an API key is easily manageable.
You can manage your API keys from
[GUI](https://portal.phonovation.com/settings/accounts/api-keys), or
programmatically
with [dedicated API](#platform-&-connectivity/settings).
API key Authorization header example:
```shell
Authorization: App
003026bbc133714df1834b8638bb496e-8f4b3d9a-e931-478d-a994-28a725159ab9
```
name: Authorization
in: header
x-default: 'App '
````
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.