Update subscription (no secret)

Partially updates a subscription owned by the caller's partner — every field is optional; send only what changes. The HMAC secret cannot be changed here (use rotate-secret). delivery_kind may be switched but must not collide with the partner's other slot. Returns the updated row (no secret).

Auth: Partner — authentication; findCallerSubscription enforces bundle_id === 1 and scopes by partner_company_id (404 if not owned).

Rate limit: No rate limit.

Request

  • Body (all sometimes):
FieldTypeRequiredNotes
labelstringnosometimes+required when present; max 255
webhook_urlstring (url)nourl:http,https, max 2048
is_activeboolnoenable/disable
delivery_kindstringnoimmediate | batch; unique-slot rule excludes the edited row by id — 422 on collision with the other slot
batch_interval_hoursint|nullrequired if delivery_kind=batchone of [1,2,4,6,12]
eventsarray|nullnonull/[] = all events; on immediate effective kind, batch-kind events rejected; hipages events rejected for non-hipages partners
events.*stringMust be one of the event names from the events catalog (GET /api/v1/partner/webhooks/events).
payload_modestringnofull | minimal

Response{ data: { data: {.} } } envelope (HTTP 200). Same presenter fields as Show one subscription, without hmac_secret.

Path params

ParameterTypeRequiredNotes
webhookSubscriptionIdintegerRequiredDigits only.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Body Params
string
string
boolean
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json