PUT

/v1/email/identities/{EmailIdentity}/dkim

http://email.{region}.amazonaws.com/v1/email/identities/{EmailIdentity}/dkim

Used to enable or disable DKIM authentication for an email identity.

Access Token Required: API Key

Path Parameters

EmailIdentitystringrequired

The email identity that you want to change the DKIM settings for.

Body Params

SigningEnabledboolean

<p>Sets the DKIM signing configuration for the identity.</p> <p>When you set this value <code>true</code>, then the messages that Amazon Pinpoint sends from the identity are DKIM-signed. When you set this value to <code>false</code>, then the messages that Amazon Pinpoint sends from the identity aren't DKIM-signed.</p>

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://email.{region}.amazonaws.com/v1/email/identities/{EmailIdentity}/dkim' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT