Pausar o quitar un envío automático
POST
https://api.afer.pro/api/v1/forms/schedules/{id}
Alias en castellano (v0, sigue operativo):
POST https://api.afer.pro/api/v1/forms/schedules/{envioId}
Pausar, reanudar o quitar una regla. Los enlaces ya enviados siguen valiendo.
Lo que se para son los enlaces nuevos y los recordatorios.
Autenticación
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.
envioIdstringobligatorio | La regla. |
accionstringopcional | pausar (por defecto), reanudar o quitar. |
Ejemplo de petición
curl -X POST 'https://api.afer.pro/api/v1/forms/schedules/aBc123XyZ' \
-H 'X-API-KEY: afer_tk_TU_TOKEN' \
-H 'X-API-SECRET: afer_sk_TU_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"accion": "pausar"
}'
<?php
$data = [
'accion' => 'pausar',
];
$ch = curl_init('https://api.afer.pro/api/v1/forms/schedules/aBc123XyZ');
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/schedules/aBc123XyZ', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': 'afer_tk_TU_TOKEN',
'X-API-SECRET': 'afer_sk_TU_SECRET'
},
body: JSON.stringify({
"accion": "pausar"
})
});
const resultado = await respuesta.json();
Respuesta
200 · application/json
{
"errorCode": 200,
"errorMsg": "",
"data": {
"envioId": "aBc123…",
"estado": "en pausa"
}
}