WebhooksActualizar suscripción

Actualizar suscripción

PATCHhttps://api.copayex.com/api/v1/webhooks/subscriptions/:id

Parámetros de solicitud

CampoTipoUbicaciónRequeridoDescripción
idstringPathSuscripción a editar.
activebooleanBody (JSON)NoActiva/desactiva la entrega.
urlstringBody (JSON)NoNuevo 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.

CampoTipoDescripción
id / uuidnumber / stringIdentificadores de la suscripción.
clientIdnumberCliente dueño de la suscripción.
urlstringEndpoint actualizado donde llegarán los webhooks.
eventsstring[]Eventos que seguirá recibiendo.
activebooleanEstado habilitado/deshabilitado después del PATCH.
secretVersionstringVersión actual del secreto (no cambia salvo rotaciones).
createdAt / updatedAtstring (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"
}