Update subscription
Updates the provided subscription fields.
Omitted fields remain unchanged. Set status to paused to stop new sends.
Authentication
Authorizationstring
Use the API key format: api-key <token>.
Path parameters
subscriptionId
Subscription identifier returned by Create subscription.
Request
This endpoint expects an object.
name
New human-readable name. It must not be blank; surrounding whitespace is removed. Omit it to keep the current name. Maximum length: 128 characters.
endpointUrl
New HTTPS delivery URL. Plain http, embedded user credentials, and fragments are rejected. Maximum length: 2048 characters.
eventTypes
Replaces the full set of subscribed event types when provided. It must contain at least one event type.
filters
Optional delivery filters for a subscription.
status
Set to paused to stop deliveries or active to resume them.
Response headers
Cache-Control
Prevents storage of webhook configuration, payload, and diagnostic responses.
Response
The updated subscription.
id
Subscription identifier.
status
active subscriptions receive deliveries; paused ones do not.
endpointUrl
HTTPS URL events are delivered to.
eventTypes
Event types this subscription receives.
createdAt
UTC timestamp when the subscription was created.
updatedAt
UTC timestamp of the last subscription change.
name
Optional human-readable name. Omitted for subscriptions created before names were introduced.
filters
Delivery filters. Omitted when none are configured.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
405
Method Not Allowed Error
406
Not Acceptable Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error