Editar
Actualiza parcialmente una automatización recurrente.
Descripción general
Este endpoint actualiza parcialmente una automatización recurrente. Todos los campos del cuerpo son opcionales:
- Omitido → el campo conserva su valor.
nullendescription,end_dateomonthly_mode→ el campo se limpia.items→ reemplaza todos los conceptos. Si no lo envías, los conceptos se conservan, pero se vuelven a guardar y susidcambian.
La automatización resultante se valida con las mismas reglas que al crearla. Después se recalculan los totales y la próxima fecha de cobro:
- Si ya no quedan fechas por cobrar, la automatización pasa a
completed, aunque estuviera pausada. - Si estaba
completedy ahora tiene una próxima fecha distinta de hoy, pasa aactive.
Editar no genera órdenes de cobro. Una solicitud exitosa devuelve 200 con la automatización completa.
Requiere el permiso Administrar en Automatizaciones.
Endpoint
https://app.credonix.mx/api/v1/recurring-automations/{automationId}Path param: automationId — el id de la automatización recurrente.
Actualización mínima
Envía solo los campos que quieras cambiar. note explica el cambio: queda en la actividad de la automatización y no forma parte de la respuesta.
{
"concept": "Póliza de mantenimiento mensual",
"note": "Ajuste del concepto"
}Reglas de los campos
| Campo | Tipo | Requerido | Notas |
|---|---|---|---|
customer_id | string | No | ID de un cliente de tu organización. |
legal_entity_id | string | No | ID de una razón social de tu organización. No acepta null. |
concept | string | No | No puede ser vacío. |
description | string | null | No | null limpia la descripción. |
currency | MXN | USD | No | |
grace_period_days | integer ≥ 0 | No | Número JSON. |
note | string | No | Máximo 500 caracteres. Se registra en la actividad; no se guarda en la automatización. |
start_date | string YYYY-MM-DD | No | |
end_date | string YYYY-MM-DD | null | No | null quita la fecha de fin. |
interval | daily, weekly, monthly, yearly | No | |
repeat_every | integer ≥ 1 | No | Número JSON. |
monthly_mode | day_of_month | weekday_position | null | No | null limpia el modo mensual. |
weekdays | array de MON a SUN | No | |
items | array | No | Reemplaza todos los conceptos. Mismas reglas que al crear. |
No se aceptan campos adicionales: cualquier campo desconocido responde 400.
Errores
| Status | Código | Causa |
|---|---|---|
400 | VALIDATION_ERROR | Un campo tiene formato inválido o se envió un campo desconocido. |
400 | INVALID_AUTOMATION | La automatización resultante no cumple sus reglas. message une las reglas que fallaron (ver Crear automatización recurrente). |
400 | CUSTOMER_NOT_FOUND | customer_id no existe en tu organización. |
400 | LEGAL_ENTITY_NOT_FOUND | legal_entity_id no existe en tu organización. |
400 | PRODUCT_NOT_FOUND | Un product_id no existe en tu organización. |
403 | INSUFFICIENT_PERMISSIONS | La API key no tiene el permiso Administrar en Automatizaciones. |
404 | NOT_FOUND | La automatización recurrente no existe en tu organización. |
Con LEGAL_ENTITY_NOT_FOUND y PRODUCT_NOT_FOUND, message es "Ocurrió un error al actualizar la automatización, por favor intenta nuevamente más tarde o contacta a soporte si el problema persiste.".