---
title: "Create User Notification"
method: POST
path: "/cloud/v2/users/{user_id}/notifications"
tags: ["Notifications", "Users"]
---

# Create User Notification

`POST /cloud/v2/users/{user_id}/notifications`

Sends a notification to a user.

## Path parameters

- `user_id` string, required

## Request body

- UserNotification — Represents a notification sent to a user.
  - `path` string — The resource path of the user notification. Format: `users/{user_id}/notifications/{user_notification_id}`
  - `id` string — A unique UUID of the user notification.
  - `source` UserNotificationSource — The source of the notification.
    - `universe` string — The universe from which the user notification is sent.
  - `payload` UserNotificationPayload — Details about the notification.
    - `type` 'TYPE_UNSPECIFIED' | 'MOMENT', enum — The type of notification. Possible values: | Value | Description | | --- | --- | | TYPE_UNSPECIFIED | The default value. This value is unused. | | MOMENT | A notification type representing a moment. |
    - `messageId` string — An ID that represents a customizable notification message template that you create in Creator Dashboard. The message can contain customizable parameters that you can specify values for. For example, `Your {egg_name} just hatched` has an `egg_name` parameter. See the `parameters` field for more information.
    - `parameters` object — A map of parameters used to render a notification message template. For example, given a template of `Your {egg_name} just hatched.` with parameters of `[{"egg_name": {"string_value": "royal egg"}}]`, the rendered notification message is: `Your royal egg just hatched.`
    - `joinExperience` UserNotificationPayloadJoinExperience — A call-to-action that represents joining an experience.
      - `launchData` string — Arbitrary data that is available to an experience when a user joins the experience with the notification. This value is limited to a maximum of 200 bytes.
    - `analyticsData` UserNotificationPayloadAnalyticsData — Data for how analytics are reported.
      - `category` string — Category of the notification, used to group analytics data. For example, "Golden egg hatched", "Bronze egg hatched", "Volcano eruptions".

## Response `200`

OK

- UserNotification — Represents a notification sent to a user.
  - `path` string — The resource path of the user notification. Format: `users/{user_id}/notifications/{user_notification_id}`
  - `id` string — A unique UUID of the user notification.
  - `source` UserNotificationSource — The source of the notification.
    - `universe` string — The universe from which the user notification is sent.
  - `payload` UserNotificationPayload — Details about the notification.
    - `type` 'TYPE_UNSPECIFIED' | 'MOMENT', enum — The type of notification. Possible values: | Value | Description | | --- | --- | | TYPE_UNSPECIFIED | The default value. This value is unused. | | MOMENT | A notification type representing a moment. |
    - `messageId` string — An ID that represents a customizable notification message template that you create in Creator Dashboard. The message can contain customizable parameters that you can specify values for. For example, `Your {egg_name} just hatched` has an `egg_name` parameter. See the `parameters` field for more information.
    - `parameters` object — A map of parameters used to render a notification message template. For example, given a template of `Your {egg_name} just hatched.` with parameters of `[{"egg_name": {"string_value": "royal egg"}}]`, the rendered notification message is: `Your royal egg just hatched.`
    - `joinExperience` UserNotificationPayloadJoinExperience — A call-to-action that represents joining an experience.
      - `launchData` string — Arbitrary data that is available to an experience when a user joins the experience with the notification. This value is limited to a maximum of 200 bytes.
    - `analyticsData` UserNotificationPayloadAnalyticsData — Data for how analytics are reported.
      - `category` string — Category of the notification, used to group analytics data. For example, "Golden egg hatched", "Bronze egg hatched", "Volcano eruptions".

---

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