Skip to main content

Documentation 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.

The Notifications API stores alerts in the 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
destinatario_tipo
string
required
Target audience: usuario or cliente.
destinatario_id
integer
required
ID of the user or client to notify (resolved against destinatario_tipo).
tipo
string
required
Notification category label (e.g. "entrega_completada", "incidencia_alta").
titulo
string
required
Short title displayed in the notification list.
mensaje
string
required
Full notification body text.
metadata
object
default:"{}"
Arbitrary key-value payload for the receiving application (e.g. {"orden_id": 42}).
curl -X POST "https://api.rappi2.com/notificaciones" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "destinatario_tipo": "usuario",
    "destinatario_id": 5,
    "tipo": "incidencia_alta",
    "titulo": "Incidencia severa registrada",
    "mensaje": "Se registró una incidencia de severidad 5 en la asignación #101.",
    "metadata": {"incidencia_id": 15, "asignacion_id": 101}
  }'
{
  "id": "664f3c4d5e6f7a8b9c0d1e2f",
  "destinatario_tipo": "usuario",
  "destinatario_id": 5,
  "tipo": "incidencia_alta",
  "titulo": "Incidencia severa registrada",
  "mensaje": "Se registró una incidencia de severidad 5 en la asignación #101.",
  "metadata": {"incidencia_id": 15, "asignacion_id": 101},
  "leida": false,
  "fecha": "2026-05-22T14:15:00Z"
}

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)
leida
boolean
Filter by read status. Omit to return both read and unread.
skip
integer
default:"0"
Pagination offset.
limit
integer
default:"50"
Maximum notifications to return (max 200).
curl -X GET "https://api.rappi2.com/notificaciones/mias?leida=false&limit=20" \
  -H "Authorization: Bearer <token>"
[
  {
    "id": "664f3c4d5e6f7a8b9c0d1e2f",
    "destinatario_tipo": "usuario",
    "destinatario_id": 5,
    "tipo": "incidencia_alta",
    "titulo": "Incidencia severa registrada",
    "mensaje": "Se registró una incidencia de severidad 5 en la asignación #101.",
    "metadata": {"incidencia_id": 15, "asignacion_id": 101},
    "leida": false,
    "fecha": "2026-05-22T14:15:00Z"
  }
]

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)
notif_id
string
required
MongoDB ObjectId of the notification.
curl -X PATCH "https://api.rappi2.com/notificaciones/664f3c4d5e6f7a8b9c0d1e2f/leer" \
  -H "Authorization: Bearer <token>"
{
  "message": "Notificacion marcada como leida"
}

Delete notification

DELETE /notificaciones/{notif_id} Permanently deletes a notification. The caller must be the notification’s intended recipient. Permission: authenticated (ownership enforced)
notif_id
string
required
MongoDB ObjectId of the notification.
curl -X DELETE "https://api.rappi2.com/notificaciones/664f3c4d5e6f7a8b9c0d1e2f" \
  -H "Authorization: Bearer <token>"

Notification response schema

id
string
required
MongoDB ObjectId as a hex string.
destinatario_tipo
string
required
Recipient type: usuario or cliente.
destinatario_id
integer
required
ID of the recipient user or client.
tipo
string
required
Notification category label.
titulo
string
required
Short notification title.
mensaje
string
required
Full notification body.
metadata
object
required
Arbitrary key-value payload attached to the notification. Defaults to {}.
leida
boolean
required
Whether the notification has been marked as read.
fecha
string
required
ISO 8601 creation timestamp.

Build docs developers (and LLMs) love