---
title: "Update Subscription"
method: PATCH
path: "/api/v1/webhook-subscriptions/{subscription_id}"
tags: ["webhook-subscriptions"]
---

# Update Subscription

`PATCH /api/v1/webhook-subscriptions/{subscription_id}`

## Request

- Base URL: `https://api.gnosari.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.gnosari.com/api/v1/webhook-subscriptions/{subscription_id}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-AUTH-TOKEN`

Patch address, kinds, ``include_provenance`` or active state.

An address change re-runs the URL guard; the stored address is unchanged
on refusal.

## Path parameters

- `subscription_id` integer, required

## Request body

- WebhookSubscriptionUpdate: Partial update -- every field optional (``python/07`` Update convention). The service re-runs the URL guard whenever ``url`` is in the patch (FR-1.3); it is never re-run for a kinds/flag-only change.
  - `url` string, nullable
  - `event_kinds` string[], nullable
  - `include_provenance` boolean, nullable
  - `active` boolean, nullable

## Response `200`

Successful Response

- WebhookSubscriptionResponse: Public view of one destination -- never carries the secret.
  - `id` integer, required
  - `url` string, required
  - `event_kinds` string[], required
  - `active` boolean, required
  - `include_provenance` boolean, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/gnosari/apis/gnosari-api.md) · [All operations](https://skmtc.dev/gnosari/apis/gnosari-api/llms.txt) · [OpenAPI document](https://skmtc.dev/gnosari/apis/gnosari-api/revisions/f299cf53ae5f?raw)