Actualizar suscripción
PATCH
https://api.copayex.com/api/v1/webhooks/subscriptions/:idParámetros de solicitud
| Campo | Tipo | Ubicación | Requerido | Descripción |
|---|---|---|---|---|
id | string | Path | Sí | Suscripción a editar. |
active | boolean | Body (JSON) | No | Activa/desactiva la entrega. |
url | string | Body (JSON) | No | Nuevo endpoint HTTPS. |
Parámetros de respuesta
Devuelve el objeto subscription actualizado (misma estructura que en “Listar suscripciones”), con la url y/o active reflejando los nuevos valores.
| Campo | Tipo | Descripción |
|---|---|---|
id / uuid | number / string | Identificadores de la suscripción. |
clientId | number | Cliente dueño de la suscripción. |
url | string | Endpoint actualizado donde llegarán los webhooks. |
events | string[] | Eventos que seguirá recibiendo. |
active | boolean | Estado habilitado/deshabilitado después del PATCH. |
secretVersion | string | Versión actual del secreto (no cambia salvo rotaciones). |
createdAt / updatedAt | string (ISO8601) | Timestamps de auditoría. |
Ejemplos de solicitud
curl -X PATCH "https://api.copayex.com/api/v1/webhooks/subscriptions/:id" \
-H "Authorization: Bearer <client_access_token>" \
-H "Content-Type: application/json" \
-d '{
"active": false,
"url": "https://webhook.site/webhook/updated"
}'Respuesta de ejemplo
{
"clientId": 1,
"url": "https://webhook.site/webhook/updated",
"events": [
"payments.item.completed",
"payments.item.partial_payment",
"payments.item.payment_failed",
"payments.item.payment_canceled"
],
"active": false,
"secretVersion": "v1",
"id": 3,
"uuid": "9cf1f29b-1846-41b3-9ebc-f4de8b7ab061",
"createdAt": "2025-11-11T01:45:11.416Z",
"updatedAt": "2025-11-11T02:01:00.000Z"
}