Users

Update my notification preferences

Merges the supplied map into the authenticated user's preferences. Send only the keys you want to change — omitted keys keep their current value. Setting a key to false stops that e-mail for this user in every account they belong to. Returns the full map. An unknown code, a non-boolean value, or an empty body is rejected with 400 and nothing is written. Not available to third-party OAuth applications (403), whatever their scopes: these are the user's personal settings. Assinafy's own apps can reach it.

Copy as Markdown Open in ChatGPT Open in Claude

put/v1/users/self/notification-preferences

Request

  • Base URL
    https://api.assinafy.com.br
  • URL
    https://api.assinafy.com.br/v1/users/self/notification-preferences
  • Auth
    • HTTP bearer
    • or API key in header X-Api-Key

Request body

DocumentCompletedboolean

Every signer has signed and the document is certified.

SignerDeclinedboolean

A signer declined to sign.

DocumentCancelledboolean

The document was cancelled.

DocumentAboutToExpireboolean

The signature deadline is approaching.

DocumentExpiredboolean

The signature deadline passed.

DocumentExpirationResetboolean

The signature deadline was extended.

DocumentProcessingFailedboolean

An uploaded document could not be processed.

TemplateProcessingFailedboolean

A template could not be processed.

SignerWhatsappFailedboolean

A WhatsApp notification to a signer could not be delivered.

Example request

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

Response

The updated 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 operation across all 14 revisions of this API.