Contact UsGet started
© 2025 Direct Cursus Technology L.L.C.

CreatePlatformApplication

Written by
Updated at April 17, 2025

Creates a mobile push notification channel.

HTTP request

POST https://notifications.yandexcloud.net/

Query parameters

Parameter

Description

Action

string
This is a required field.
Operation type parameter.
Value: CreatePlatformApplication.

Name

string
This is a required field.
Notification channel name. See the naming requirements in Creating a push notification channel.
E.g., com.example.app.

Platform

string
This is a required field.
Platform for sending mobile push notifications or in-browser notifications.
The possible values are:

FolderId

string
Required field when authenticating via an IAM token.
ID of the folder the notification channel is created in. When authenticating via a static service account key, if FolderId is not specified, the channel is created in the same folder as the service account.
E.g., b1gsm0k26v1l********.

Attributes.entry.N.key

string
This is a required field.
Attribute key. N is a numeric value.
E.g., Attributes.entry.1.key=PlatformPrincipal&Attributes.entry.2.key=PlatformCredential.

Attributes.entry.N.value

string
This is a required field.
Attribute value. N is a numeric value.
E.g., Attributes.entry.1.value=c8gzjriSVxDDzX2fAV********&Attributes.entry.2.value=CgB6e3x9iW/qiE9l9wAUPK0e/bJQe5uIgTlYUD4bP********.

ResponseFormat

string
Response format.
The possible values are:

  • XML (default)
  • JSON.

Attributes

Common attributes

Attribute Description
Description string
Application description.
Example: Test application

APNS and APNS_SANDBOX attributes

Attribute Description
PlatformPrincipal string
Token ID in .p8 format or SSL certificate in .p12 format. Token-based authentication is preferred as a more modern option.
PlatformCredential string
Token or private key of the SSL certificate.
ApplePlatformTeamID string
Developer ID, only when using a token.
ApplePlatformBundleID string
App ID (bundle ID), only when using a token.

FCM attributes

Attribute Description
PlatformCredential string
Key of the Google Cloud service account in JSON format for authentication with the HTTP v1 API or API key (server key) for authentication with the legacy API. The HTTP v1 API is preferred as FCM will no longer support the legacy API starting from June 2024.

HMS attributes

Attribute Description
PlatformPrincipal string
Key ID.
PlatformCredential string
API key.

RUSTORE attributes

Attribute Description
PlatformPrincipal string
Project ID.
PlatformCredential string
Service token.

For more information about authentication attributes, see the Mobile push notification channels subsection.

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 version="1.0" encoding="UTF-8"?>
<CreatePlatformApplicationResponse>
    <ResponseMetadata>
  	  <RequestId>string</RequestId>
    </ResponseMetadata>
    <CreatePlatformApplicationResult>
  	  <PlatformApplicationArn>string</PlatformApplicationArn>
    </CreatePlatformApplicationResult>
</CreatePlatformApplicationResponse>

{
  "ResponseMetadata": {
    "RequestId": "string"
  },
  "CreatePlatformApplicationResult": {
    "PlatformApplicationArn": "string"
  }
}

Where:

  • RequestId: Request ID
  • PlatformApplicationArn: Notification channel ID (ARN)

Error response

In case of an error, Cloud Notification Service returns a message with the appropriate HTTP code and its additional description in XML or JSON format depending on the specified ResponseFormat parameter.

Data schema:

<?xml version="1.0" encoding="UTF-8"?>
<ErrorResponseXML>
    <RequestId>string</RequestId>
    <Error>
  	  <Code>string</Code>
  	  <Message>string</Message>
    </Error>
</ErrorResponseXML>

{
  "ErrorResponse": {
    "RequestId": "string",
    "Error": {
      "Code": "string",
      "SubCode": "string",
      "Message": "string"
    }
  }
}

Where:

  • RequestId: Request ID
  • Code: Error code
  • Message: Error description

For a list of common error codes for all actions, see Errors.

Errors specific for CreatePlatformApplication:

HTTP Error code Extended code Description
400 InvalidParameter AppAlreadyExists A mobile push notification channel with such name and platform already exists.
400 InvalidParameter DeletedAppAlreadyExists You cannot use the name and platform to create a new mobile push notification channel because a channel with the same parameters was recently deleted, and the mobile platform data has not yet been updated.

See also

Previous
Errors
Next
GetAttributes