---
title: "Update a webhook endpoint"
method: PATCH
path: "/api/v1/customer/webhooks/{id}"
tags: ["Webhooks"]
---

# Update a webhook endpoint

`PATCH /api/v1/customer/webhooks/{id}`

## Request

- Base URL: `https://virtualsms.io`
- URL: `https://virtualsms.io/api/v1/customer/webhooks/{id}`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in query parameter `api_key`

## Path parameters

- `id` string, required

## Request body

- WebhookUpdate: Partial update — send only the fields you want to change. At least one of these must be present or the request is rejected with 400. Sending `events` re-validates `threshold` against the new event list. Un-pausing (`paused: false` on a paused endpoint) also resets `failure_count_consecutive` to 0.
  - `url` string, uri
  - `description` string, nullable
  - `events` string[]
  - `threshold` number, float, nullable
  - `active` boolean
  - `paused` boolean

## Response `200`

Updated

- object
  - `success` boolean
  - `webhook` Webhook
    - `id` string
    - `url` string, uri
    - `description` string, nullable
    - `events` string[]
    - `active` boolean: Set by you. An inactive endpoint receives nothing.
    - `paused` boolean: Set automatically after repeated delivery failures. Un-pause by PATCHing `paused: false`, which also clears the failure counter.
    - `threshold` number, float, nullable
    - `failure_count_consecutive` integer
    - `last_delivered_at` string, date-time, nullable
    - `last_error_at` string, date-time, nullable
    - `last_error_code` string, nullable: HTTP status or transport error recorded on the last failed delivery.
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `secret` string: HMAC signing secret. Returned **exactly once**, in the 201 response to `POST /api/v1/customer/webhooks`. It is never returned again by any other endpoint — store it when you create the webhook.

## Other responses

- `400`: No updatable field supplied, or a field failed validation
- `404`: Not found, or not yours

---

[API](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and.md) · [All operations](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/llms.txt) · [OpenAPI document](https://skmtc.dev/virtualsms/apis/virtualsms-account-verification-platform-for-developers-and/revisions/be89af981be1?raw)