Accounts

Updates envelope notification default settings

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

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

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

Request Body

application/json

apiEmailNotifications?

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

emailNotifications?

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

Response Body

application/json

application/json

curl -X PUT "https://example.com/v2.1/accounts/string/settings/notification_defaults" \  -H "Content-Type: application/json" \  -d '{}'
{  "apiEmailNotifications": {    "senderEmailNotifications": {      "changedSigner": "string",      "clickwrapResponsesLimitNotificationEmail": "string",      "commentsOnlyPrivateAndMention": "string",      "commentsReceiveAll": "string",      "deliveryFailed": "string",      "envelopeComplete": "string",      "offlineSigningFailed": "string",      "powerformResponsesLimitNotificationEmail": "string",      "purgeDocuments": "string",      "recipientViewed": "string",      "senderEnvelopeDeclined": "string",      "withdrawnConsent": "string"    },    "signerEmailNotifications": {      "agentNotification": "string",      "carbonCopyNotification": "string",      "certifiedDeliveryNotification": "string",      "commentsOnlyPrivateAndMention": "string",      "commentsReceiveAll": "string",      "documentMarkupActivation": "string",      "envelopeActivation": "string",      "envelopeComplete": "string",      "envelopeCorrected": "string",      "envelopeDeclined": "string",      "envelopeVoided": "string",      "faxReceived": "string",      "offlineSigningFailed": "string",      "purgeDocuments": "string",      "reassignedSigner": "string",      "whenSigningGroupMember": "string"    }  },  "emailNotifications": {    "senderEmailNotifications": {      "changedSigner": "string",      "clickwrapResponsesLimitNotificationEmail": "string",      "commentsOnlyPrivateAndMention": "string",      "commentsReceiveAll": "string",      "deliveryFailed": "string",      "envelopeComplete": "string",      "offlineSigningFailed": "string",      "powerformResponsesLimitNotificationEmail": "string",      "purgeDocuments": "string",      "recipientViewed": "string",      "senderEnvelopeDeclined": "string",      "withdrawnConsent": "string"    },    "signerEmailNotifications": {      "agentNotification": "string",      "carbonCopyNotification": "string",      "certifiedDeliveryNotification": "string",      "commentsOnlyPrivateAndMention": "string",      "commentsReceiveAll": "string",      "documentMarkupActivation": "string",      "envelopeActivation": "string",      "envelopeComplete": "string",      "envelopeCorrected": "string",      "envelopeDeclined": "string",      "envelopeVoided": "string",      "faxReceived": "string",      "offlineSigningFailed": "string",      "purgeDocuments": "string",      "reassignedSigner": "string",      "whenSigningGroupMember": "string"    }  }}