Programar un envío automático
https://api.afer.pro/api/v1/forms/{id}/schedules
POST https://api.afer.pro/api/v1/forms/{formularioId}/schedules
Que el formulario salga solo a quien le toque: p. ej. a los 21 días de incorporarse, con recordatorios.
Cada mañana se crea el enlace personal de quien cumple la regla y se le envía por correo: dias_desde_alta (N días después del alta de su contrato) o dias_antes_fin_prueba (N días antes de que acabe su periodo de prueba). A la propia persona, o a su responsable (encargados de su departamento o de su centro) sobre la persona. Cada contrato cuenta una vez, y solo los hechos desde desde (por defecto hoy): programar una regla no escribe a toda la plantilla histórica.
En dos pasos: sin confirmar devuelve la regla en palabras, a quién saldría ya y quién viene en 30 días, y no crea nada.
Envía tus claves API en las cabeceras X-API-KEY y X-API-SECRET. La cuenta sobre la que se opera se resuelve automáticamente a partir de la clave. Cómo obtener tus claves →
Este endpoint requiere autenticación. La empresa tiene que tener el módulo de formularios activado (si no, 403). A nombre de una persona, como en el panel: administración y RRHH; los confidenciales, solo RRHH y quien los creó.
Parámetros del cuerpo
El cuerpo de la petición es un objeto JSON con Content-Type: application/json.
formularioIdstringobligatorio | El formulario (de empresa o por invitación). |
cuandostringobligatorio | dias_desde_alta o dias_antes_fin_prueba. |
diasintobligatorio | N días. |
a_quienstringopcional | persona (por defecto) o responsable. |
departamentosarrayopcional | Nombres o ids. Vacío = toda la plantilla. |
recordar_cada_diasintopcional | Por defecto 3; 0 = sin recordatorios. |
max_recordatoriosintopcional | Por defecto 2. |
desdestringopcional | YYYY-MM-DD, como mucho 90 días atrás. |
confirmarboolopcional | Crea la regla. |
Ejemplo de petición
curl -X POST 'https://api.afer.pro/api/v1/forms/aBc123XyZ/schedules' \
-H 'X-API-KEY: afer_tk_TU_TOKEN' \
-H 'X-API-SECRET: afer_sk_TU_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"cuando": "dias_desde_alta",
"dias": 21,
"a_quien": "persona",
"confirmar": true
}'
<?php
$data = [
'cuando' => 'dias_desde_alta',
'dias' => 21,
'a_quien' => 'persona',
'confirmar' => true,
];
$ch = curl_init('https://api.afer.pro/api/v1/forms/aBc123XyZ/schedules');
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-KEY: afer_tk_TU_TOKEN',
'X-API-SECRET: afer_sk_TU_SECRET',
'Content-Type: application/json',
]);
$respuesta = json_decode(curl_exec($ch), true);
curl_close($ch);
const respuesta = await fetch('https://api.afer.pro/api/v1/forms/aBc123XyZ/schedules', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': 'afer_tk_TU_TOKEN',
'X-API-SECRET': 'afer_sk_TU_SECRET'
},
body: JSON.stringify({
"cuando": "dias_desde_alta",
"dias": 21,
"a_quien": "persona",
"confirmar": true
})
});
const resultado = await respuesta.json();
Respuesta
{
"errorCode": 200,
"errorMsg": "",
"data": {
"creado": true,
"envioId": "aBc123…",
"formulario": "Tu incorporación",
"regla": "21 días después de incorporarse · a la propia persona · toda la plantilla · recuerda cada 3 días (2 veces)",
"desde": "2026-10-23"
}
}