---
title: "Send Push"
method: POST
path: "/v2/notifications"
---

# Send Push

`POST /v2/notifications`

This endpoint can only be used with your Server credentials and allows you to send notifications directly to one or more customers.

## Request body

- object
  - `target` object, required
    - `userIds` string[] — The list of CustomerIDs that should receive the message, max length per entry 255
    - `installIds` string[] — The list of VisitorIDs that should receive the message, max length per entry 255
  - `content` object
    - `title` string, required
    - `message` string, required
    - `url` string — Set a Url to be opened in the device browser
    - `data` string, json — Optional object of additional key:values to be passed in the notification payload for your app to consume
    - string
  - `collapseId` string
  - `runBackgroundHandler` boolean — Sets `content-available` for iOS
  - `ios` object
    - `category` string — This will trigger your UNNotificationContentExtension whose ID matches this category.
    - `badge` object
      - `type` 'incrementBy' | 'setTo'
      - `count` integer — Positive or Negative integer. Set to 0 to clear badge.
    - `sound` string — Sound file to play instead of the default device notification sound. Pass 'none' to disable vibration and sound for the notification.
    - `media` object
      - `pictureUrl` string — URL for image to include in notification
  - `android` object
    - `highPriority` boolean — Boolean, sets priority flag to wake up Android devices
    - `sound` string — Sound file that is included in your app to play instead of the default device notification sound.
    - `pictureUrl` string — URL for image to include in notification
    - `notificationType` 'general' | 'important' — General will use the default channel on device and drop into the notification tray. Important will present a heads-up notification. Cannot be combined with notificationChannel.
    - `notificationChannel` string — ID of the notification channel on the device to put the notification into, must exist on the device or will fallback to "general". Cannot be combined with notificationType.
  - `web` object
    - `media` object
      - `iconUrl` string
      - `pictureUrl` string
  - `schedule` object
    - `sendAt` string — DateTime of format "Y-m-d" (for strategy "intelligent") or "Y-m-d H:i" otherwise
    - `strategy` 'local' | 'utc' | 'timezone' | 'intelligent'
    - `pastTimes` 'ignore' | 'nextDay'
    - `timezone` string — IANA Time Zone string
  - `buttons` object[]
    - `id` string, required — Identifier of the button available in handler as 'actionId'. Required if buttons are set.
    - `text` string, required — Label for the button. Required if buttons are set
  - `userMeta` string, json — Object keyed by customerID of meta-data for each recipient
  - `ttl` integer — Number of seconds the message should be held at the messaging gateways for delivery attempts if the device is not currently online. Maximum of 2419200s (28 days), defaults to 3 days if not set.

## Response `202`

202

- object
  - `errors` object
    - `unknownUserIds` string[]
    - `unsubscribedUserIds` object[]
  - `notification` object
    - `id` integer
    - `title` string
    - `message` string
    - `isBackgroundData` boolean
    - `url` unknown
    - `iosConfig` object
      - `hasBadge` boolean
      - `badgeType` string
      - `badgeCount` integer
    - `androidConfig` object
      - `notificationType` string
    - `collapseId` unknown
    - `soundConfig` unknown
    - `messageId` integer
    - `webConfig` unknown
    - `appId` integer
    - `source` integer
    - `filters` object
      - `userIds` string[]
    - `schedule` unknown
    - `data` object
      - `key` string
    - `buttons` unknown
    - `ttl` integer

## Other responses

- `400` — 400
- `401` — 401
- `422` — 422

---

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