---
title: "Edit event subscription"
method: PUT
path: "/v2/event-subscriptions/{subscription_id}"
---

# Edit event subscription

`PUT /v2/event-subscriptions/{subscription_id}`

## Request

- Base URL: `https://api.signnow.com`
- URL: `https://api.signnow.com/v2/event-subscriptions/{subscription_id}`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/signnow/apis/signnow-api/docs/v2/event-subscriptions/:subscription_id/put.ts> (a function with typed inputs; its response is checked against the schema)

This endpoint allows users to update an existing event subscription.

## Request body

- object
  - `event` string, required: Event that should trigger the subscription.
  - `action` string: Always only "callback"
  - `entity_id` string, required: ID of the entity that should trigger the subscription.
  - `attributes` object, required
    - `headers` object: You can add any parameters to the "headers" array.
      - `int_head` integer
      - `bool_head` boolean
      - `float_head` number
      - `string_head` string
    - `callback` string, required: URL that should receive the callback.
    - `secret_key` string: Enables the HMAC security logic.
    - `use_tls_12` boolean: If true, the 1.2 TLS version will be used. If false, the default TLS version will be used.
    - `integration_id` string: External system ID
    - `docid_queryparam` boolean: If true, a JSON that is sent in a callback will contain document ID as a query string parameter and as a part of "callback_url" parameter.
    - `include_metadata` boolean: Whether the payload of the webhook should include metadata.
    - `delete_access_token` boolean: Determines whether to keep access_token in the payload. If true, an access_token key id removed from the payload. If false, the access_token is kept in the payload attributes.

## Response `204`

Success, no content

- object

## Other responses

- `400`: * Incorrect Bearer token. * `event` is not a string. * `event` is empty. * `event` doesn't exist. * `entity_id` is not a string. * `entity_id` is missing. * `entity_id` is not 40 characters long. * `attributes` is not an array. * `attributes` is empty. * `attributes` error. * `callback` is not a string. * `callback` is empty. * `callback` is missing. * `callback` is not a valid email address. * `callback` URL is not allowed. * `callback` host unknown or unreachable. * `use_tls_12` is not a boolean. * `integration_id` is not a string. * `integration_id` is not 40 characters long. * Incorrect `integration_id`. * `docid_queryparam` is not a boolean. * `headers` is not an array. * `secret_key` is not a string. * `secret_key` is empty. * `secret_key` is longer than 300 characters. * `delete_access_token` is not a boolean. * `include_metadata` is not a boolean.
- `403`: * The bearer token is valid but it belongs to another user. * Subscription update is not allowed. * API subscription is not found. * API subscription is inactive. * API subscription has expired.
- `404`: * The entity ID doesn't exist. * The subscription ID doesn't exist.

---

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