Users

Get my notification preferences

Which owner-facing document notifications the authenticated user receives by e-mail. All nine keys are always returned; everything defaults to true. Account and security e-mail (welcome, password reset, invitations, account deletion) is not configurable and never appears here.

Copy as Markdown Open in ChatGPT Open in Claude

get/v1/users/self/notification-preferences

Response

The current preferences

statusinteger

HTTP status code, mirrored in the body.

messagestring

Human-readable message; empty on success.

Example response

{
  "status": 200,
  "data": {
    "DocumentCompleted": true,
    "SignerDeclined": true,
    "DocumentCancelled": true,
    "DocumentAboutToExpire": true,
    "DocumentExpired": true,
    "DocumentExpirationReset": true,
    "DocumentProcessingFailed": true,
    "TemplateProcessingFailed": true,
    "SignerWhatsappFailed": true
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.