ASassinafy
Accounts

Update the workspace notification policy

Changed on

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 Open in ChatGPT Open in Claude

put/v1/accounts/{accountId}/notification-policy

Request

Path parameters

accountIdstring required

Workspace account ID.

Request body

owners_receive_allboolean

Example request

{
  "events": {
    "DocumentCompleted": true,
    "SignerDeclined": true,
    "DocumentCancelled": true,
    "DocumentAboutToExpire": true,
    "DocumentExpired": true,
    "DocumentExpirationReset": true,
    "DocumentProcessingFailed": true,
    "TemplateProcessingFailed": true,
    "SignerWhatsappFailed": true,
    "ContractRenewalNotice": true,
    "ContractExpiring": true,
    "ContractExpired": true,
    "ContractRenewed": true,
    "SignerSigned": true,
    "SignerIdentityReviewRequired": true
  },
  "owners_receive_all": true
}

Response

The updated policy

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "editable": true,
    "events": {
      "DocumentCompleted": true,
      "SignerDeclined": true,
      "DocumentCancelled": true,
      "DocumentAboutToExpire": true,
      "DocumentExpired": true,
      "DocumentExpirationReset": true,
      "DocumentProcessingFailed": true,
      "TemplateProcessingFailed": true,
      "SignerWhatsappFailed": true,
      "ContractRenewalNotice": true,
      "ContractExpiring": true,
      "ContractExpired": true,
      "ContractRenewed": true,
      "SignerSigned": true,
      "SignerIdentityReviewRequired": true
    }
  }
}

Changes