---
title: "Update the workspace notification policy"
method: PUT
path: "/v1/accounts/{accountId}/notification-policy"
tags: ["Accounts"]
---

# Update the workspace notification policy

`PUT /v1/accounts/{accountId}/notification-policy`

## Request

- Base URL: `https://api.assinafy.com.br`
- URL: `https://api.assinafy.com.br/v1/accounts/{accountId}/notification-policy`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
- TypeScript: <https://skmtc.dev/assinafy/apis/assinafy-api-reference/docs/v1/accounts/:accountId/notification-policy/put.ts> (a function with typed inputs; its response is checked against the schema)

Owners only (`403` for other members). Merges the supplied fields: send only `events` keys you want to change, and/or `owners_receive_all`. An event set to `false` reaches nobody in this workspace, on any channel, whatever each member's own preferences; the identity review e-mail is the exception and is always sent, because the signer cannot continue without it. An unknown field or code, a non-boolean value or an empty body is rejected with `400` and nothing is written. Returns the full policy.

[Copy as Markdown](https://api.assinafy.com.br/v1/docs/markdown?method=put&path=%2Fv1%2Faccounts%2F%7BaccountId%7D%2Fnotification-policy) [Open in ChatGPT](https://chatgpt.com/?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dput%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Fnotification-policy%20and%20help%20me%20integrate%20this%20endpoint.) [Open in Claude](https://claude.ai/new?q=Read%20the%20API%20documentation%20at%20https%3A%2F%2Fapi.assinafy.com.br%2Fv1%2Fdocs%2Fmarkdown%3Fmethod%3Dput%26path%3D%252Fv1%252Faccounts%252F%257BaccountId%257D%252Fnotification-policy%20and%20help%20me%20integrate%20this%20endpoint.)

## Path parameters

- `accountId` string, required

## Request body

- object
  - `events` NotificationPolicyEvents: Every e-mail and push alert, keyed by notification type. `false` means the workspace never sends it. New keys may be added.
    - `DocumentCompleted` boolean
    - `SignerDeclined` boolean
    - `DocumentCancelled` boolean
    - `DocumentAboutToExpire` boolean
    - `DocumentExpired` boolean
    - `DocumentExpirationReset` boolean
    - `DocumentProcessingFailed` boolean
    - `TemplateProcessingFailed` boolean
    - `SignerWhatsappFailed` boolean
    - `ContractRenewalNotice` boolean
    - `ContractExpiring` boolean
    - `ContractExpired` boolean
    - `ContractRenewed` boolean
    - `SignerViewed` boolean
    - `SignerSigned` boolean
    - `SignerIdentityReviewRequired` boolean: Turns off the push only; the identity review e-mail is always sent.
  - `owners_receive_all` boolean

## Response `200`

The updated policy

- object: Standard success wrapper. Operations add their own `data`.
  - `status` integer: HTTP status code, mirrored in the body.
  - `message` string: Human-readable message; empty on success.
  - `data` NotificationPolicy: The workspace's notification rules, set by its owners.
    - `editable` boolean: Whether the requesting user is an owner and can change the policy.
    - `owners_receive_all` boolean: Owners also get the push alerts for every member's documents. Each owner's own preferences still apply.
    - `events` NotificationPolicyEvents: Every e-mail and push alert, keyed by notification type. `false` means the workspace never sends it. New keys may be added.
      - `DocumentCompleted` boolean
      - `SignerDeclined` boolean
      - `DocumentCancelled` boolean
      - `DocumentAboutToExpire` boolean
      - `DocumentExpired` boolean
      - `DocumentExpirationReset` boolean
      - `DocumentProcessingFailed` boolean
      - `TemplateProcessingFailed` boolean
      - `SignerWhatsappFailed` boolean
      - `ContractRenewalNotice` boolean
      - `ContractExpiring` boolean
      - `ContractExpired` boolean
      - `ContractRenewed` boolean
      - `SignerViewed` boolean
      - `SignerSigned` boolean
      - `SignerIdentityReviewRequired` boolean: Turns off the push only; the identity review e-mail is always sent.

## Other responses

- `400`: One or more fields failed validation.
- `401`: Missing or invalid credentials.
- `500`: Unexpected server error.

## Changes

> 20 revisions in range; 1 not diffed.

- **2026-11-10** `d1af2d2ca42e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/assinafy/apis/assinafy-api-reference/changes/v1/accounts/:accountId/notification-policy/put.md)

---

[API](https://skmtc.dev/assinafy/apis/assinafy-api-reference.md) - [All operations](https://skmtc.dev/assinafy/apis/assinafy-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/assinafy/apis/assinafy-api-reference/revisions/511261bfe294?raw)