Crear invitaciones en lote

POST /v1/invitations:batch · permiso invitations:write

Crea de 1 a 100 invitaciones (items). Cada elemento sigue las reglas de POST /v1/invitations y se escribe de forma independiente: un elemento que falla no detiene a los demás. La respuesta es 200 OK y items mantiene el orden de la solicitud; el status de un elemento es 201 (nueva invitación), 200 (se reenvió una invitación pendiente) o el estado HTTP de su error, y un elemento fallido incluye error con code, status y punteros de campo de la forma /items/<i>/…. El accept_url de los elementos link_only solo se devuelve en esta respuesta (Cache-Control: no-store); una respuesta reproducida con Idempotency-Key no tiene enlaces y devuelve secret_redacted: true. Un elemento sin organization_id es una invitación al entorno. Un elemento email se envía por correo electrónico; si el envío de invitaciones por correo no está configurado para la implementación, es un error de elemento 501 not_implemented, y un application_id que no existe en este entorno es un error de elemento 404 not_found. Cada invitación escrita se audita como invitation.created.

Solicitud

Campo Tipo Obligatorio Descripción
items object[] sí 1 a 100 invitaciones, cada una con los campos de POST /v1/invitations.
Idempotency-Key header no Hace que un reintento devuelva el resultado almacenado sin enlaces.

Respuesta

200 OK con un resultado por elemento.

{
  "items": [
    {
      "status": 201,
      "invitation": {
        "id": "inv_01j9xt9v3w4y8z0a2b4c6d8e0g",
        "organization_id": "org_01j9xk3m7q8r2s4t6v8w0y2z4a",
        "email": "ada@example.com",
        "role_ids": [
          "rol_01j9xr7s1t2w6x8y0z2a4b6c8e"
        ],
        "application_id": null,
        "delivery": "link_only",
        "delivery_status": "not_sent",
        "status": "pending",
        "send_count": 1,
        "last_sent_at": "2026-10-12T09:31:00.123456Z",
        "expires_at": "2026-10-19T09:31:00.123456Z",
        "accepted_user_id": null,
        "accepted_at": null,
        "revoked_at": null,
        "created_at": "2026-10-12T09:31:00.123456Z",
        "updated_at": "2026-10-12T09:31:00.123456Z",
        "version": 1,
        "accept_url": "https://acme.eu.keenauth.app/u/login?invitation=<token>"
      }
    },
    {
      "status": 422,
      "error": {
        "code": "validation_failed",
        "status": 422,
        "errors": [
          {
            "pointer": "/items/1/email",
            "code": "invalid_value"
          }
        ]
      }
    }
  ]
}

Errores

HTTP code Cuándo
422 validation_failed items falta, está vacío o tiene más de 100 elementos.
401 unauthenticated La credencial falta, no es válida o fue revocada.
403 insufficient_permissions La credencial no tiene el permiso requerido. Un elemento con un rol privilegiado (is_privileged) falla con este error de elemento cuando la credencial no tiene roles:write.
429 rate_limited Se superó el límite de frecuencia; reintente después del periodo indicado en Retry-After.
503 service_unavailable Una dependencia no está disponible temporalmente; reintente después del periodo indicado en Retry-After.

Ejemplo

curl -i -X POST "https://api.eu.keenauth.com/v1/invitations:batch" \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: 0f6c1d2e3a4b5c6d7e8f9a0b" \
  -d '{"items":[{"organization_id":"org_01j9xk3m7q8r2s4t6v8w0y2z4a","email":"ada@example.com","delivery":"link_only"},{"organization_id":"org_01j9xk3m7q8r2s4t6v8w0y2z4a","email":"bob@example.com","delivery":"link_only"}]}'

Datos personales

Este endpoint contiene datos personales: membresías de organizaciones e invitaciones. Datos personales en las API de KeenAuth describe qué se almacena, durante cuánto tiempo se conserva y cómo se elimina. No envíe categorías especiales de datos personales (salud, datos biométricos, religión, opiniones políticas, orientación sexual) en ningún campo.