---
title: "Update Webhook"
method: PUT
path: "/webhooks/{webhookId}"
tags: ["Webhooks"]
---

# Update Webhook

`PUT /webhooks/{webhookId}`

## Request

- Base URL: `https://api.thanks.io/api/v2`
- URL: `https://api.thanks.io/api/v2/webhooks/{webhookId}`
- Auth: HTTP bearer

Update an existing webhook destination. Webhooks are available on paid subscriptions only.

## Request body

- object
  - `url` string, uri, required
  - `description` string, nullable
  - `verb` string, required
  - `type` 'order_item.status_update' | 'order.status_update' | 'order_item.delivered' | 'scans.scan_update' | 'scan_board.status_update', required
  - `scan_board_status` 'new' | 'contacted' | 'follow_up' | 'done' | 'null', nullable: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.

## Response `200`

OK

- object
  - `id` integer
  - `user_id` integer
  - `mailing_list_id` integer, nullable
  - `type` 'order_item.status_update' | 'order.status_update' | 'order_item.delivered' | 'scans.scan_update' | 'scan_board.status_update'
  - `scan_board_status` 'new' | 'contacted' | 'follow_up' | 'done' | 'null', nullable: The Scan Board stage this webhook fires on. Required when type is scan_board.status_update; null for other types.
  - `description` string, nullable
  - `invoke_count` integer
  - `url` string, uri
  - `verb` string
  - `created_at` string, date-time, nullable
  - `updated_at` string, date-time
  - `deleted_at` string, date-time, nullable

## Other responses

- `403`: Access token is missing or invalid
- `404`: Resource not found

## Changes

- **2026-10-19** `6a3359b14347`: 1 warning, 3 info
  - added the new `scan_board.status_update` enum value to the `type` response property for the response status `200`
  - added the new optional request property `scan_board_status`
  - added the new `scan_board.status_update` enum value to the request property `type`
  - added the optional property `scan_board_status` to the response with the `200` status
- **2026-10-19** `bbe02ffe74f3`: 1 breaking, 2 warning, 1 info
  - removed the enum value `scan_board.status_update` of the request property `type`
  - removed the request property `scan_board_status`
  - removed the optional property `scan_board_status` from the response with the `200` status
  - removed the `scan_board.status_update` enum value from the `type` response property for the response status `200`
- **2026-10-18** `c10cfeb34552`: 1 warning, 3 info
  - added the new `scan_board.status_update` enum value to the `type` response property for the response status `200`
  - added the new optional request property `scan_board_status`
  - added the new `scan_board.status_update` enum value to the request property `type`
  - added the optional property `scan_board_status` to the response with the `200` status
- …earlier changes not shown

[Operation history](https://skmtc.dev/thanks-io/apis/thanks-io-api/changes/webhooks/:webhookId/put.md)

---

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