Notifications

Send a notification

Send a notification to the given <strong>{recipientId}</strong>. <br> See the full description of request fields with the schema <strong>SendNotificationParameters</strong>

post/pimcore-studio/api/notifications/send

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /pimcore-studio/api/notifications/send
  • Auth: none declared

Request body

recipientIdinteger required

recipient ID

titlestring required

title

messagestring required

message

attachmentType'asset' | 'document' | 'object' nullable

type of the attachment

attachmentIdinteger nullable

ID of the attachment

Example request

{
  "title": "New notification",
  "message": "My notification message",
  "attachmentId": 83
}

Response

Successfully sent notification

Changes

No recorded changes to this operation across all 2 revisions of this API.