Anular un recordatorio interno
POST
https://api.afer.pro/api/v1/reminders/{id}/cancel
Alias en castellano (v0, sigue operativo):
POST https://api.afer.pro/api/v1/reminders/{id}/cancel
Que no salga un recordatorio que aún está pendiente.
Lo puede anular quien lo programó, a quien va dirigido o un administrador. Uno que ya ha salido no se puede anular (responde 409).
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, a nombre de una persona.
Parámetros del cuerpo
El cuerpo de la petición es un objeto JSON con Content-Type: application/json.
recordatorioIdstringobligatorio | En la ruta. El de consultarRecordatoriosInternos. |
motivostringopcional | Por qué. Queda en el historial de la tarea. |
Ejemplo de petición
curl -X POST 'https://api.afer.pro/api/v1/reminders/aBc123XyZ/cancel' \
-H 'X-API-KEY: afer_tk_TU_TOKEN' \
-H 'X-API-SECRET: afer_sk_TU_SECRET' \
-H 'Content-Type: application/json' \
-d '{
"motivo": "Ya está hecho"
}'
<?php
$data = [
'motivo' => 'Ya está hecho',
];
$ch = curl_init('https://api.afer.pro/api/v1/reminders/aBc123XyZ/cancel');
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/reminders/aBc123XyZ/cancel', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'X-API-KEY': 'afer_tk_TU_TOKEN',
'X-API-SECRET': 'afer_sk_TU_SECRET'
},
body: JSON.stringify({
"motivo": "Ya está hecho"
})
});
const resultado = await respuesta.json();
Respuesta
200 · application/json
{
"errorCode": 200,
"errorMsg": "",
"data": {
"anulado": true,
"recordatorio": {
"recordatorioId": "aBc123…",
"estado": "cancelada"
}
}
}
Notas
Admite X-IDEMPOTENCY-KEY.