Accounts: updateNotificationDefaults

This method changes the default settings for the email notifications that signers and senders receive about envelopes.

Request

HTTP request

PUT /v2.1/accounts/{accountId}/settings/notification_defaults

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID GUID.

Responses

CodeDescriptionReference
200

Successful response.

NotificationDefaults
400

Error encountered.

errorDetails

SDK Method

Accounts::updateNotificationDefaults

Definitions

errorDetails

This object describes errors that occur. It is only valid for responses and ignored in requests.

errorCodestring

The code associated with the error condition.

messagestring

A brief message describing the error condition.

notificationDefaultSettings

Contains details about the default notification settings for the envelope notifications that senders and signers receive.

senderEmailNotificationssenderEmailNotifications

An array of email notifications that sets the email the user receives when they are a sender. When the specific email notification is set to true, the user will receive those types of email notifications from DocuSign.

The user inherits the default account sender email notification settings when the user is created. The email notifications are:

  • envelopeComplete
  • changedSigner
  • senderEnvelopeDeclined
  • withdrawnConsent
  • recipientViewed
  • deliveryFailed

signerEmailNotificationssignerEmailNotifications

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

senderEmailNotifications

Contains the settings for the email notifications that senders receive about the envelopes that they send.

changedSignerstring

When set to true, the sender receives an email notification if the signer changes.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments that mention their own user name.

commentsReceiveAllstring

When set to true, the user receives all comments.

deliveryFailedstring

When set to true, the sender receives an email notification if envelope delivery fails.

envelopeCompletestring

When set to true, the user receives an email notification when the envelope has been completed.

offlineSigningFailedstring

When set to true, the user receives an email notification if offline signing failed.

purgeDocumentsstring

When set to true, the user receives an email notification when a document purge occurs.

recipientViewedstring

When set to true, the sender receives notification that a recipient viewed the envelope.

senderEnvelopeDeclinedstring

When set to true, the sender receives notification that the envelope was declined.

withdrawnConsentstring

When set to true, the user receives an email notification if consent is withdrawn.

signerEmailNotifications

An array of email notifications that specifies the email the user receives when they are a sender. When the specific email notification is set to true, the user receives those types of email notifications from DocuSign. The user inherits the default account sender email notification settings when the user is created.

agentNotificationstring

When set to true, the user receives agent notification emails.

carbonCopyNotificationstring

When set to true, the user receives notifications of carbon copy deliveries.

certifiedDeliveryNotificationstring

When set to true, the user receives notifications of certified deliveries.

commentsOnlyPrivateAndMentionstring

When set to true, the user receives only comments that mention their own user name.

commentsReceiveAllstring

When set to true, the user receives all comments.

documentMarkupActivationstring

When set to true, the user receives notification that document markup has been activated.

envelopeActivationstring

When set to true, the user receives notification that the envelope has been activated.

envelopeCompletestring

When set to true, the user receives an email notification when the envelope has been completed.

envelopeCorrectedstring

When set to true, the user receives notification that the envelope has been corrected.

envelopeDeclinedstring

When set to true, the user receives notification that the envelope has been declined.

envelopeVoidedstring

When set to true, the user receives notification that the envelope has been voided.

faxReceivedstring

Reserved for DocuSign.

offlineSigningFailedstring

When set to true, the user receives an email notification if offline signing failed.

purgeDocumentsstring

When set to true, the user receives an email notification when a document purge occurs.

reassignedSignerstring

When set to true, the user receives notification that the envelope has been reassigned.

whenSigningGroupMemberstring

When set to true, the user receives notification that he or she is a member of the signing group.

NotificationDefaults

The NotificationDefaults resource provides methods that enable you to manage the default notifications for envelopes.

apiEmailNotificationsnotificationDefaultSettings

The default notification settings for envelopes sent by using the console.

emailNotificationsnotificationDefaultSettings

The default notification settings for envelopes sent by using the API.

}} />