cargopanel logocargopanel for developers

Update Subscription

PUThttps://api.cargopanel.co/webhooks/subscriptions/{subscriptionId}

Update an existing webhook subscription. All fields are optional — only provide the fields you want to change.

Request Fields

subscriptionIdstringrequired

The ID of the webhook subscription (path parameter).

urlstringoptional

New HTTPS URL for webhook deliveries.

eventsstring[]optional

Updated array of event types to subscribe to.

headersobjectoptional

Updated custom headers. Only X-* headers are allowed.

retryPolicyobjectoptional

Updated retry policy settings.

isActivebooleanoptional

Set to false to pause the subscription, or true to re-activate it.

Example Response

200
{
  "success": true,
  "data": {
    "id": "sub_abc123",
    "url": "https://example.com/webhooks/v2",
    "events": ["shipment.status.updated"],
    "headers": {},
    "retryPolicy": {
      "maxRetries": 5,
      "initialDelayMs": 10000,
      "backoffMultiplier": 2,
      "maxDelayMs": 3600000
    },
    "isActive": true,
    "createdAt": "2026-06-20T14:30:00.000Z",
    "updatedAt": "2026-06-22T09:15:00.000Z"
  }
}

Responses

200Subscription updated successfully
400Invalid request body
401Unauthorized (invalid or missing API key)
404Subscription not found