Notification
The Notification API helps you acquire notifications to your user and mark as read
Path parameters
orgUUIDstringRequired
A valid uuid of an organization
Header parameters
x-request-idstringOptional
It is an identifier provided by the API client that will be used to identify distributed logs.
Responses
200
Ok
*/*
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
get
GET /org/{orgUUID}/notifications/user HTTP/1.1
Host:
Accept: */*
[
{
"createdAt": "2025-06-29T20:49:12.076Z",
"read": true,
"messages": [
{
"language": "text",
"title": "text",
"message": "text",
"url": "text",
"action": "text"
}
]
}
]
Path parameters
orgUUIDstringRequired
A valid uuid of an organization
Header parameters
x-request-idstringOptional
It is an identifier provided by the API client that will be used to identify distributed logs.
Responses
204
No Content
400
Bad Request
*/*
401
Unauthorized
*/*
403
Forbidden
*/*
404
Not Found
*/*
409
Conflict
*/*
422
Unprocessable Entity
*/*
500
Internal Server Error
*/*
put
PUT /org/{orgUUID}/notifications/user HTTP/1.1
Host:
Accept: */*
No content
Last updated
Was this helpful?