Update account notification settings

PUT https://www.digicert.com/services/v2/account/settings

Use this endpoint to update CertCentral account notification settings, including certificate lifecycle email recipient configurations, organization validation email preferences, and account balance notifications.

Important

To update the email addresses that receive CertCentral account notifications and emergency emails, use the Update account emails endpoint.

Example requests and responses

Example 1. cURL

curl -X PUT \
  https://www.digicert.com/services/v2/account/settings \
  -H 'Content-Type: application/json' \
  -H 'X-DC-DEVKEY: {{api_key}}' \
  -d '{
    "account_settings": [
        {
            "name": "confirmation_email_recipients",
            "value": "[\"order-users\",\"org-contact\",\"tech-contact\",\"admin\"]"
        },
        {
            "name": "rejection_email_recipients",
            "value": "[\"order-users\",\"org-contact\",\"tech-contact\",\"admin\"]"
        },
        {
            "name": "approval_email_recipients",
            "value": "[\"order-users\",\"org-contact\",\"tech-contact\",\"admin\"]"
        },
        {
            "name": "renewal_email_recipients",
            "value": "[\"order-users\",\"org-contact\",\"tech-contact\",\"admin\"]"
        },
        {
            "name": "email_preference",
            "value": "{\"org-approval\":[\"all\"]}"
        },
        {
            "name": "account_fund_expiry_notices",
            "value": 1
        },
        {
            "name": "account_fund_adjustment_notices",
            "value": 1
        },
        {
            "name": "no_top_level_container_in_email",
            "value": 0
        }
    ]
}'

Request parameters

Name	Req/Opt	Type	Description
account_settings	required	array	List of account notification settings to update. Each setting contains a `name` and a `value`.
.. name	required	string	Name of the account notification setting being updated. For more information, see Value and description for account notification setting names table.
.. value	required	string / integer	Value for the name of the account notification setting. For email recipients and preferences, the value is a comma-separated string. For the account balance notification and the inclusion of division name in organization validation related emails, the value is an integer. For more information, see Value and description for account notification setting names table.

Value and description for account notification setting names

Name	Value	Description
confirmation_email_recipients	`\"admin\"`, `\"tech-contact\"`, `\"org-contact\"`, `\"order-users\"`	Recipients for order confirmation emails. You can specify one or multiple values from the comma-separated list as needed.
rejection_email_recipients	`\"order-users\"`, `\"org-contact\"`, `\"tech-contact\"`, `\"admin\"`	Recipients for order rejection emails. You can specify one or multiple values from the comma-separated list as needed.
approval_email_recipients	`\"order-users\"`, `\"org-contact\"`, `\"tech-contact\"`, `\"admin\"`	Recipients for order approval emails. You can specify one or multiple values from the comma-separated list as needed.
renewal_email_recipients	`\"order-users\"`, `\"org-contact\"`, `\"tech-contact\"`, `\"admin\"`	Recipients for renewal (expiring) and expired certificate emails. You can specify one or multiple values from the comma-separated list as needed.
email_preference	`({\"org-approval\":[\"all\"]})` or `({\"org-approval\":[]})`	Enables `({\"org-approval\":[\"all\"]})` or disables `({\"org-approval\":[]})` the delivery of the organization validation emails to the individual who placed the order. The system is hard-coded to always send organization validation emails to the organization contact. In this parameter, you can request to add the email of the person who placed the order to the list of recipients of the organization validation email.
account_fund_expiry_notices	`1` or `0`	Enables (`1`) or disables (`0`) notifications for account fund expiration.
account_fund_adjustment_notices	`1` or `0`	Enables (`1`) or disables (`0`) notifications for account adjustments.
no_top_level_container_in_email	`1` or `0`	Enables (`0`) or disables (`1`) inclusion of division name in organization validation related emails.

Response parameters

Name	Type	Description
status	string	If `success`, guest access is enabled for the account. Otherwise, failure.
message	string	Describes the outcome of the request.

In this section: