The Notifications API stores alerts in theDocumentation Index
Fetch the complete documentation index at: https://mintlify.com/JorLOrT/rappi2/llms.txt
Use this file to discover all available pages before exploring further.
notificaciones MongoDB collection. Each notification targets either a platform user (destinatario_tipo: "usuario") or a client (destinatario_tipo: "cliente"). The /mias and /{id}/leer / /{id} (DELETE) endpoints are caller-scoped — they operate only on notifications belonging to the authenticated user.
All endpoints require a valid Bearer token. Creating notifications requires
notificaciones:write. Reading and mutating your own inbox requires only authentication.Create notification
POST /notificaciones
Create a notification and deliver it to a specific user or client.
Permission: notificaciones:write
Target audience:
usuario or cliente.ID of the user or client to notify (resolved against
destinatario_tipo).Notification category label (e.g.
"entrega_completada", "incidencia_alta").Short title displayed in the notification list.
Full notification body text.
Arbitrary key-value payload for the receiving application (e.g.
{"orden_id": 42}).List my notifications
GET /notificaciones/mias
Returns notifications addressed to the authenticated caller, resolved automatically from the caller’s identity. If the caller has a cliente_id, the inbox uses destinatario_tipo: "cliente"; otherwise it uses destinatario_tipo: "usuario".
Permission: authenticated (no additional permission required)
Filter by read status. Omit to return both read and unread.
Pagination offset.
Maximum notifications to return (max
200).Mark notification as read
PATCH /notificaciones/{notif_id}/leer
Marks a notification as read. The caller must be the notification’s intended recipient.
Permission: authenticated (ownership enforced)
MongoDB ObjectId of the notification.
Delete notification
DELETE /notificaciones/{notif_id}
Permanently deletes a notification. The caller must be the notification’s intended recipient.
Permission: authenticated (ownership enforced)
MongoDB ObjectId of the notification.
Notification response schema
MongoDB ObjectId as a hex string.
Recipient type:
usuario or cliente.ID of the recipient user or client.
Notification category label.
Short notification title.
Full notification body.
Arbitrary key-value payload attached to the notification. Defaults to
{}.Whether the notification has been marked as read.
ISO 8601 creation timestamp.