---
title: "Update a webhook subscription"
method: PATCH
path: "/v1/webhooks/{webhookId}/"
tags: ["/v1/webhook"]
---

# Update a webhook subscription

`PATCH /v1/webhooks/{webhookId}/`

## Request

- Base URL: `https://api.counselhealth.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.counselhealth.com/v1/webhooks/{webhookId}/`
- Auth: HTTP bearer

Update a webhook subscription by ID. Pass null to unset optional fields in the DB. Only the fields passed will be updated.

## Path parameters

- `webhookId` string, required

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `name` string, nullable
  - `destination` string, starts_with
  - `status` 'active' | 'inactive'

## Response `200`

Default Response

- object
  - `id` string, uuid, required
  - `name` string, nullable, required
  - `destination` string, starts_with, required
  - `status` 'active' | 'inactive', required
  - `created_at` string, date-time, required: datetime in ISO 8601 format
  - `updated_at` string, date-time, required: datetime in ISO 8601 format

## Other responses

- `400`: 400 error with a machine-readable `code` for client branching.
- `401`: Standard error body returned for non-2xx responses.
- `403`: Standard error body returned for non-2xx responses.
- `404`: Standard error body returned for non-2xx responses.
- `409`: Standard error body returned for non-2xx responses.
- `413`: Standard error body returned for non-2xx responses.
- `429`: Standard error body returned for non-2xx responses.
- `500`: Standard error body returned for non-2xx responses.
- `502`: Default Response
- `503`: Default Response
- `504`: Default Response

---

[API](https://skmtc.dev/counselhealth/apis/counsel-api.md) - [All operations](https://skmtc.dev/counselhealth/apis/counsel-api/llms.txt) - [OpenAPI document](https://skmtc.dev/counselhealth/apis/counsel-api/revisions/4110a89127e8?raw)