Skip to main content

Communication

Manages communication with customers, including notifications, emails, and messaging.

Push Token

A push notification is a message or alert sent by an application to a user's device, even when the app is not actively in use. These notifications are typically used to deliver timely and relevant information, updates, reminders, or promotions to users. They appear on the device's home screen or in the notification center and can include text, images, or other media. Push notifications are a powerful tool for engaging users, keeping them informed, and encouraging them to interact with the application. A push token is a unique identifier generated by a mobile operating system when a mobile application registers to receive push notifications. This token is used by the application server to send push notifications to the specific device. It acts as a form of address, allowing the server to target and deliver notifications to the intended recipient app on the user's device. This resource allows you to manage push notification tokens associated with mobile applications. You can upsert (update or insert) push tokens for individual users or devices. This is crucial for sending targeted push notifications to users who have opted in to receive them, allowing you to engage with your mobile app's audience effectively.

Operations
POST
/service/application/communication/v1.0/pn-token
# Update or adds app push token
POST

Update or adds app push token

Update or inserts the push token of the user.
Parameters
body
object (PushtokenReq)
Required
Check the request body shown below or refer `PushtokenReq` for more details
PushtokenReq
action
string
The type of operation to perform with the push token, such as create, update, or reset.
Enum
bundle_identifier
string
Unique identifier used to identify a bundle.
push_token
string
A string of codes containing comprehensive data that identifies a identity of requester.
unique_device_id
string
Unique identifier used to identify a device.
type
string
Source address of the requestee.
Response
200
400
Success. Check the example shown below or refer `PushtokenRes` for more details.
PushtokenRes
_id
string
Key used to uniquely identify document that contains push token credentials.
bundle_identifier
string
Unique identifier used to identify a bundle.
push_token
string
A string of codes containing comprehensive data that identifies a identity of requester.
unique_device_id
string
Unique identifier used to identify a device.
type
string
Source address of the requester.
platform
string
Source address of the requester.
application_id
string
The ID of the sales channel associated with the push token.
user_id
string
Identifier which can uniquely identify the user.
created_at
string
The timestamp indicating when a record was initially created.
updated_at
string
The timestamp indicating when a record was last modified or updated.
expired_at
string
The timestamp indicating when a record is set to expire or become invalid.
Examples
Parameters
Parameters are not required.
Was this section helpful?
POST
/service/application/communication/v1.0/pn-token
Loading...
Response
Example response not available.