CreatePlatformEndpoint
Written by
Updated at April 17, 2025
Creates an endpoint for push notifications (subscribes the user to push notifications).
HTTP request
POST https://notifications.yandexcloud.net/
Query parameters
| Parameter | Description |
|---|---|
Action |
string Required field. Operation type parameter. Value: CreatePlatformEndpoint. |
PlatformApplicationArn |
string Required field. Mobile push notification channel or in-browser push notification channel ID. Example: arn:aws:sns::aoegtvhtp8ob********:app/GCM/test-cns-9990. |
Token |
string Required field. For mobile notifications: unique token on the user device (Registration ID) created by the notification service for the app. For in-browser notifications: PushSubscription object received in the user's browser, in JSON format. |
CustomUserData |
string Other user data that can be stored together with the endpoint. Cloud Notification Service does not use this data in any way. |
ResponseFormat |
string Response format. The possible values are:
|
Response
Successful response
If there are no errors, Cloud Notification Service returns the 200 HTTP code.
A successful response contains additional data in XML or JSON format depending on the specified ResponseFormat parameter.
Data schema:
XML
JSON
<?xml version="1.0" encoding="UTF-8"?>
<CreatePlatformEndpointResponse>
<ResponseMetadata>
<RequestId>string</RequestId>
</ResponseMetadata>
<EndpointArn>string</EndpointArn>
</CreatePlatformEndpointResponse>
{
"ResponseMetadata": {
"RequestId": "string"
},
"EndpointArn": "string"
}
Where:
RequestId: Request ID.EndpointArn: Mobile endpoint ID (ARN).
Error response
In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code.
For a list of common error codes for all actions, see Errors.