Schedule Alert Rules

POST

/api/alerts/schedule

Schedules alert-processing jobs for multiple users using the internal Agenda scheduler.

This endpoint creates one scheduled job per user in the userIds array.

Scheduling Behavior

Each user receives an independent scheduled job

Jobs are executed asynchronously at the specified dueDate

The endpoint immediately returns after all jobs are successfully queued

Important Notes

dueDate must be a valid ISO-8601 datetime string

Extremely large userIds arrays may be rate-limited in future versions

Solicitud

Autorización

API Key

Agregar parámetro en header

x-api-key

Ejemplo:

x-api-key: ********************

Parámetros del Body application/jsonRequerido

Ejemplos

Respuestas

🟢200

application/json

Alert jobs scheduled successfully.

Bodyapplication/json

🟠400

🟠401

🟠403

🔴500

Ejemplo de Solicitud

Shell

JavaScript

Java

Swift

curl --location 'https://api.dufrei.com/api/alerts/schedule' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "tenantId": "XAXX010101000",
    "userIds": [
        "USR_10293"
    ],
    "ruleId": "RULE_EXPIRING_DOCUMENTS",
    "cycleKey": "2026-05",
    "nameAlert": "end-trip",
    "extraData": {
        "key1": "value1",
        "key2": "value2"
    },
    "dueDate": "2026-05-25T18:00:00Z",
    "individual": true
}'

Ejemplo de Respuesta

200 - Ejemplo 1

{
    "success": true,
    "message": "3 alertas individuales programadas en el panel administrativo."
}

Modificado en 2026-06-25 19:02:02

Health Check

Schedule Alert Rules

Scheduling Behavior#

Important Notes#

Solicitud

Respuestas

Scheduling Behavior

Important Notes