Create in-app notification
POST
/v1/admin/notifications/in-appCreate an active HTML in-app notification shown to all authenticated users.
How to call this endpoint
Every ACP API request uses bearer authentication. The examples here show the actual request path, auth header, and body shape that the platform expects.
Path, query, and header parameters
These parameters control which ACP object the endpoint acts on and how the request is processed.
Path parameters
None.
Query parameters
None.
Body schema
Content type: application/json · Required
| Field | Type | Required | Description |
|---|---|---|---|
| id | string | No | Optional stable notification ID. Auto-generated when omitted. |
| html | string | Yes | HTML string beginning with a div element. |
| expiresAt | string | No | — |
| metadata | object | No | Free-form metadata object. |
What the API returns
Each response code below includes the documented payload shape for the ACP API.
201In-app notification createdapplication/json
| Field | Type | Required | Description |
|---|---|---|---|
| notification | object | No | — |
| notification.id | string | No | Unique identifier. |
| notification.html | string | No | Sanitizable HTML div content for the notification body. |
| notification.createdAt | string | No | ISO 8601 timestamp. |
| notification.createdBy | string | No | — |
| notification.expiresAt | string | No | — |
| notification.metadata | object | No | Free-form metadata object. |