---
title: "Add base Mobile Push message"
method: POST
path: "/api/v1/messages/mobilepush"
tags: ["Messages"]
---

# Add base Mobile Push message

`POST /api/v1/messages/mobilepush`

The method is used for creating new Mobile Push message.

## Request body

- BaseMobilePushMessage
  - `id` integer — Message ID.
  - `name` string, required — Message name.
  - `languageCode` string — Language code.
  - `tags` string[] — List of tags.
  - `subscriptionsKeys` string[] — Subscription categories keys, assigned to a message.
  - `languages` string[] — An array with the language codes for multilingual messages. Available for the GET method only.
  - `title` string, required — Message title.
  - `subtitle` string — Message subtitle. Visible only to iOS users.
  - `text` string, required — Message text.
  - `link` string — Can be either an external link (opens in device browser) or a deep link (opens some section of the app).
  - `imageSource` string — Image URL for a single image in a message. Use 'images' array to create an images carousel.
  - `customData` string — Additional parameters in JSON format to be used in the push message.
  - `ttlSec` integer — Time-to-live for a message; in seconds.
  - `buttons` MobilePushButton[] — Use buttons to implement various actions. 4 buttons for iOS, 3 buttons for Android are supported.
    - `actionId` string, required — <b>Required parameter.</b><br>Unique action id for the button.
    - `label` string, required — <b>Required parameter.</b><br>Text shown on the button.
    - `iosIconPath` string — Icon associated with the button action. Supported on iOS 15+.
    - `link` string — An URL or a deeplink where user will go if selects the button.
    - `customData` string — Additional parameters of the button; in JSON format.
  - `soundEnabled` boolean — Enable to play sound when user receives push-message.
  - `badgeCount` integer — The number of unread messages shown to the user.
  - `images` string[] — The array of image URLs for images carousel. Up to 10 images.
  - `translations` MobilePushMessage[] — The array of language versions for the current message. Available for GET method only.
    - `id` integer — Message ID.
    - `name` string, required — Message name.
    - `languageCode` string — Language code.
    - `tags` string[] — List of tags.
    - `subscriptionsKeys` string[] — Subscription categories keys, assigned to a message.
    - `languages` string[] — An array with the language codes for multilingual messages. Available for the GET method only.
    - `title` string, required — Message title.
    - `subtitle` string — Message subtitle. Visible only to iOS users.
    - `text` string, required — Message text.
    - `link` string — Can be either an external link (opens in device browser) or a deep link (opens some section of the app).
    - `imageSource` string — Image URL for a single image in a message. Use 'images' array to create an images carousel.
    - `customData` string — Additional parameters in JSON format to be used in the push message.
    - `ttlSec` integer — Time-to-live for a message; in seconds.
    - `buttons` MobilePushButton[] — Use buttons to implement various actions. 4 buttons for iOS, 3 buttons for Android are supported.
      - `actionId` string, required — <b>Required parameter.</b><br>Unique action id for the button.
      - `label` string, required — <b>Required parameter.</b><br>Text shown on the button.
      - `iosIconPath` string — Icon associated with the button action. Supported on iOS 15+.
      - `link` string — An URL or a deeplink where user will go if selects the button.
      - `customData` string — Additional parameters of the button; in JSON format.
    - `soundEnabled` boolean — Enable to play sound when user receives push-message.
    - `badgeCount` integer — The number of unread messages shown to the user.
    - `images` string[] — The array of image URLs for images carousel. Up to 10 images.

## Response `200`

---

[API](https://skmtc.net/esputnik/apis/esputnik-com.md) · [All operations](https://skmtc.net/esputnik/apis/esputnik-com/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/esputnik/esputnik-com/versions/1c4afd7ba72a/schema)