---
title: "Edit event subscription (basic auth)"
method: PUT
path: "/api/v2/events/{event_subscription_id}"
---

# Edit event subscription (basic auth)

`PUT /api/v2/events/{event_subscription_id}`

## Request

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

This endpoint allows API users to change an existing event subscription. This request uses Basic authorization. For the request with Bearer authorization, see [Update event subscription (bearer auth)](/docs/manage-event-subscriptions/operations/put-v2-event-subscriptions-subscription-id).

## Request body

- object
  - `event` string, required: Name of the event, for example `document.complete`. See the [list of events](/docs/guides-webhooks#entity-events).
  - `action` string, required: Action to perform when the event occurs. Always `callback`.
  - `entity_id` string, required: ID of the document, document group, or user the event relates to.
  - `attributes` object, required: Callback settings.
    - `headers` object: Custom headers to send with each callback, as key-value pairs. Values can be strings, numbers, or booleans.
    - `callback` string, required: URL that receives the callback.
    - `use_tls_12` boolean: Whether to use TLS 1.2 for the callback request.
    - `integration_id` string: ID of the integration the subscription belongs to.
    - `docid_queryparam` boolean: Whether to add the document ID to the callback URL as a query parameter.

## Response `200`

The event subscription was updated.

- object
  - `id` string: ID of the updated event subscription.

## Other responses

- `400`: * "attributes must not be empty" - "attributes" array is missing or empty. * "'callback' is missing." - required parameter "callback" is missing. * "Action must be equal 'callback'" - required parameter "action" is missing OR value of "action" parameter differs from 'callback'. * "event must not be empty" - required parameter "event" is missing or has an empty value. * "event must be string" - value of the "event" parameter is not a string. * "callback must be string" - value of the "callback" parameter is not a string. * "callback must be url" - value of "callback" parameter is not an URL. * "Invalid integration id - {integration_id}" - value of "integration_id" parameter doesn't exist in database.

---

[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)