put-domain-identity-dkim-attributes.md

PutDomainIdentityDkimAttributes method

Enables or disables DKIM signing for an address. This option allows the recipient to check that an email was indeed sent from the claimed domain. It is used for anti-phishing and anti-spam measures.

Request {#request}

PUT /v2/email/identities/{DomainIdentity}/dkim HTTP/2

Path parameters {#path-parameters}

#| || Parameter | Description || || DomainIdentity | Type: String.

Address to enable or disable DKIM authentication for. The minimum length is one character. || |#

Request headers {#request-headers}

{% include api-request-headers %}

Request body {#request-body}

{
  "SigningEnabled": <DKIM_usage>
}

#| || Parameter | Description || || SigningEnabled | Type: Boolean.

Enables or disables DKIM signing for sending emails from the specified address. Possible values: true or false. || |#

Responses {#responses}

200 OK {#200}

{% include api-response-200 %}

Errors {#errors}

{% include api-errors %}

Possible errors:

#| || Error code | Description || || 400 BadRequestException | The request contains invalid headers or parameters. || || 404 NotFoundException | The requested resource was not found. || || 429 TooManyRequestsException | The request quota was exceeded. || |#