---
title: "Update Subscription"
method: PATCH
path: "/apiHub/webhooks/v1/subscriptions/{id}"
tags: ["Subscriptions"]
---

# Update Subscription

`PATCH /apiHub/webhooks/v1/subscriptions/{id}`

## Request

- Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known)
- URL: `dc1demogwext.paylocity.com/apiHub/webhooks/v1/subscriptions/{id}`
- Auth: HTTP bearer

> 🚧 Early Access API Version
> This endpoint version is currently in Early Access and available only to approved early adoption (EA) participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

**Summary Description**

 Updates an existing webhook subscription using the provided `id`. This endpoint enables clients to modify specific aspects of the subscription—such as the target URL, event types, or authentication settings without requiring the subscription to be recreated.

## Path parameters

- `id` string, uuid, required

## Headers

- `Authorization` string, required

## Request body

- UpdateSubscriptionV1ModelJsonPatchDocument
  - `operations` UpdateSubscriptionV1ModelOperation[], required: The list of JSON Patch operations to apply to the subscription. Each path may appear only once, and `auth` paths for different authentication types cannot be combined.
    - `operationType` 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test' | 'invalid'
    - `path` string, required: The field to update. Allowable Values with their permitted `op`: - `/name`, `/url`, `/eventTypes`, `/status`: `replace` - `/auth`: `replace` (replaces the authentication configuration) - `/auth/hmac/key1`, `/auth/hmac/key2`: `add` (creates the key) - `/auth/hmac/key1/expirationAt`, `/auth/hmac/key2/expirationAt`: `replace` (changes the key expiration)
    - `op` 'replace' | 'add', required: The patch operation to perform. Allowable Values: `replace`, `add`. The operation permitted depends on `path`.
    - `from` string, nullable: Not supported. The `move` and `copy` operations are not allowed.
    - `value` unknown, required

## Response `200`

OK. Returned when the update changes authentication settings. Contains the resulting HMAC key details, including the secret of any newly created key.

- UpdateSubscriptionV1Response: The authentication configuration resulting from the update. Returned only when the update changes authentication settings.
  - `type` string, nullable: The authentication type configured for the subscription. Allowable Values: HMAC.
  - `hmac` UpdateSubscriptionHmacAuthV1Response
    - `key1` CreateSubscriptionHmacKeyV1Response
      - `keyId` string, uuid, nullable: The unique identifier of the HMAC key.
      - `secret` string, nullable: The HMAC secret used to sign webhook deliveries. Returned only in the response that creates the key.
      - `issuedAt` string, date-time, nullable: The date and time the HMAC key was issued.
      - `expirationAt` string, date-time, nullable: The date and time the HMAC key expires.
    - `key2` CreateSubscriptionHmacKeyV1Response
      - `keyId` string, uuid, nullable: The unique identifier of the HMAC key.
      - `secret` string, nullable: The HMAC secret used to sign webhook deliveries. Returned only in the response that creates the key.
      - `issuedAt` string, date-time, nullable: The date and time the HMAC key was issued.
      - `expirationAt` string, date-time, nullable: The date and time the HMAC key expires.

## Other responses

- `204`: No Content. Returned when the update does not change authentication settings.
- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/paylocity/apis/webhooks-api.md) - [All operations](https://skmtc.dev/paylocity/apis/webhooks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/webhooks-api/revisions/4206e9534cc6?raw)