Update Certificate Request's Notification Configuration

Determine the conditions under which notifications will be sent and to whom they will be sent for a specific certificate request.

Key information:

• By default, your account-level notification configuration determines the conditions under which notifications will be sent and to whom they will be sent. Use the Get Default Notification Configuration endpoint to retrieve this configuration.
• A certificate request's notification configuration supersedes your account-level configuration. For example, if you update the recipients for a certificate request's CertificateRenewal notifications, then that type of notification will only be sent to those recipients regardless of your account-level configuration.
• You cannot disable a notification that has been enabled on your account-level configuration.

Request

Update a certificate request's notification configuration through the following endpoint:

HTTP Method	Request URI
PATCH	https://api.vdms.io/sec/cps/v2.0/certificates/Certificate Request ID/notifications

Define the following variable when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
Certificate Request ID Required	Replace this variable with the system-defined ID for the desired certificate request. Use the Get All Certificate Requests endpoint to retrieve a list of certificate requests and their system-defined ID.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

Unlike requests to api.edgecast.com, requests to our API gateway (api.vdms.io) require an access token (OAuth).

Request Body

Pass the following request body parameters:

Name	Data Type	Description
notification_type Required	String	Identifies the type of notification that will be configured. Valid values are: CertificateRenewal | CertificateExpiring | PendingValidations
emails	Array of string values	Required when enabled=true Defines one or more email addresses to which a notification will be sent. Set this parameter to an email address associated with a MCC user in your account. Your account manager may also define an email address associated with a partner user. Our service returns a 400 Bad Request when this parameter is set to any other email address.
enabled	Boolean	Determines whether emails for this type of notification will be sent.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request (200 OK) contains the following response elements.

Name	Data Type	Description
@id	String	Indicates the relative path to an endpoint through which you may retrieve the notification configuration for the requested certificate request.
@type	String	Returns Collection.
items	Array of objects	Contains the notification configuration for the requested certificate request.

items Array

The items array describes each notification configuration for this certificate request through the following properties:

Name	Data Type	Description
notification_type	String	Indicates the type of notification. Valid values are: CertificateRenewal | CertificateExpiring | PendingValidations
emails	Array of string values	Indicates one or more email addresses to which a notification will be sent.
enabled	Boolean	Indicates whether emails for this type of notification will be sent.

Errors

The response body for an unsuccessful request may contain an error element that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

[{
		"notification_type": "CertificateRenewal",
		"emails": ["joe@example.com", "jane@example.com"],
		"enabled": true
	}
]

A sample JSON response is shown below.

{
	"@id": "/v2.0/certificates/11400/notifications",
	"@type": "Collection",
	"items": [{
			"notification_type": "CertificateRenewal",
			"emails": [
				"joe@example.com",
				"jane@example.com"
			],
			"enabled": true
		}, {
			"notification_type": "CertificateExpiring",
			"emails": [
				"joe@example.com"
			],
			"enabled": true
		}, {
			"notification_type": "PendingValidations",
			"emails": [
				"jane@example.com"
			],
			"enabled": true
		}
	]
}