Update DKIM Key Status

curl --request PATCH \
  --url https://api.mailchannels.net/tx/v1/domains/{domain}/dkim-keys/{selector} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '{}'

{
  "errors": [
    "<string>"
  ]
}

Update DKIM Key Status

Update fields of an existing DKIM key pair for the specified domain and selector, for the current customer. Currently, only the status field can be updated. revoked: Indicates that the key is compromised and should not be used. retired: Indicates that the key has been rotated and is no longer in use. rotated: Indicates that the key is going through the rotation process. Only active key pairs can be updated to this status, and no new key pair is created. The rotated key can be used to sign emails for 3 days after the status update, and will automatically change to ‘retired’ 2 weeks after update. For a smooth key transition, it is recommended to create and publish a new key pair before signing is disabled for the rotated key.

PATCH

domains

{domain}

dkim-keys

{selector}

Update DKIM Key Status

curl --request PATCH \
  --url https://api.mailchannels.net/tx/v1/domains/{domain}/dkim-keys/{selector} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <x-api-key>' \
  --data '{}'

{
  "errors": [
    "<string>"
  ]
}

Headers

X-Api-Key

string

required

Path Parameters

domain

string

required

selector

string

required

Required string length: 1 - 63

Body

application/json

status

enum<string>

required

New status of the DKIM key pair

Available options:

revoked,

retired,

rotated

Response

Key pair status updated successfully

Create DKIM Key Pair Rotate DKIM Key Pair

⌘I