---
title: "Update webhook subscription"
method: PATCH
path: "/v2/webhook-subscriptions/{subscriptionId}"
tags: ["Webhook Event Subscriptions"]
---

# Update webhook subscription

`PATCH /v2/webhook-subscriptions/{subscriptionId}`

## Request

- Base URL: `https://api.prod.goaugment.com`
- URL: `https://api.prod.goaugment.com/v2/webhook-subscriptions/{subscriptionId}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/goaugment/apis/augment-api/docs/v2/webhook-subscriptions/:subscriptionId/patch.ts> (a function with typed inputs; its response is checked against the schema)

Partially updates a public webhook subscription. Only `webhookEndpointId` and `isActive` are updatable. `eventType` is not updatable; create a new subscription to change event type. At least one field is required.

Access to webhook management is gated by brokerage. Talk to Augment to enable access before relying on this endpoint.

## Request body

- UpdateWebhookSubscriptionRequest: Request body for partially updating a public webhook subscription. At least one field is required. `eventType` is not updatable.
  - `webhookEndpointId` string: New webhook endpoint ID for this subscription
  - `isActive` boolean: Whether this subscription should be active

## Response `200`

Webhook subscription updated successfully

- WebhookSubscription: Public webhook subscription connecting one webhook endpoint to one event type.
  - `id` string, required: Webhook subscription ID
  - `webhookEndpointId` string, required: Webhook endpoint ID that receives this event type
  - `eventType` 'TRACKING_UPDATE' | 'STOP_UPDATE' | 'LOAD_CARRIER_UPDATE' | 'SEND_TMS_COMMENT' | 'SCHEDULED_CARRIER_OUTREACH' | 'UPLOAD_FILES' | 'PUSH_BID_TO_TMS' | 'PUSH_LOAD_DRAFT' | 'CARRIER_ISSUE_UPDATED', required: Public event type for webhook subscription creation. Call `GET /v2/webhook-event-types` for the current source of truth.
  - `isActive` boolean, required: Whether this subscription is active

## Other responses

- `400`: Bad request
- `401`: Unauthorized
- `403`: Webhook management access is not enabled for this brokerage
- `404`: Webhook subscription not found
- `409`: Webhook endpoint already has a subscription for this event type

---

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