ONonesignal

Create inbox broadcast message

Changed on

Broadcast a message to users' inboxes.

post/apps/{app_id}/inbox

Request

  • Base URL
    https://api.onesignal.com
  • URL
    https://api.onesignal.com/apps/{app_id}/inbox
  • Auth
    none required

Path parameters

app_idstring required

Your OneSignal App ID in UUID v4 format. See Keys & IDs.

Headers

Authorizationstring required

Your App API key with prefix Key . See Keys & IDs.

Request body

namestring required

An internal name you set to help organize and track messages. Not shown to recipients. Maximum 128 characters. Required, and must be non-empty.

img_urlstring

The URL to an image that is associated with this message.

send_afterstring

Schedule delivery for a future date/time (in UTC). The format must be valid per the ISO 8601 standard and compatible with JavaScript's Date() parser. Example: 2025-09-24T14:00:00-07:00

datastring

An arbitrary string (which can contain encoded JSON if desired) that is passed through to messages. This is meant for use in client applications and is not processed in any special way by OneSignal. If you need structured data, encode it as a JSON string. Example: "{\"abc\":\"123\"}"

Response

200

idstring

The message ID in UUID v4 format.

Changes