DKIM

Manage DKIM (DomainKeys Identified Mail) keys for email authentication. DKIM signing improves deliverability and prevents email spoofing.

List Dkim Keys

GET

https://api.cakemail.dev

/brands/default/dkim

List all DKIM keys configured for the account.

Required scope(s): dkim:read

List Dkim Keys › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

List Dkim Keys › Responses

Successful Response

DkimKeysResponse

DkimKeyListItemResponse[] · required

List of DKIM keys

Create Dkim Key

POST

https://api.cakemail.dev

/brands/default/dkim

Create a new DKIM key for a domain. Returns the DNS records that must be added to your domain's DNS configuration.

Required scope(s): dkim:write

Create Dkim Key › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Create Dkim Key › Request Body

CreateDkim

domain

string · required

selector

string

Create Dkim Key › Responses

Successful Response

CreateDkimResponse

object · required

Created DKIM key details

object

string

Object type

Default: dkim

created

boolean

Whether the DKIM key was created

Default: true

Get Dkim Key

GET

https://api.cakemail.dev

/brands/default/dkim/{id}

Retrieve a DKIM key's details, including the DNS records that need to be configured.

Required scope(s): dkim:read

Get Dkim Key › path Parameters

id

integer · required

Get Dkim Key › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Get Dkim Key › Responses

Successful Response

DkimKeyResponse

object · required

DKIM key details

Delete Dkim Key

DELETE

https://api.cakemail.dev

/brands/default/dkim/{id}

Delete a DKIM key.

Required scope(s): dkim:delete

Delete Dkim Key › path Parameters

id

integer · required

Delete Dkim Key › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete Dkim Key › Responses

Successful Response

DeleteDkimKeyResponse

object · required

Deleted DKIM key details

object

string

Object type

Default: dkim

deleted

boolean

Whether the DKIM key was deleted

Default: true

Activate Dkim Key

POST

https://api.cakemail.dev

/brands/default/dkim/{id}/activate

Mark a DKIM key as active.

The server runs a live DNS check and refuses the call if DNS does not confirm the key (no TXT record published, or a TXT exists but does not match the stored public key).

Required scope(s): dkim:write

Activate Dkim Key › path Parameters

id

integer · required

Activate Dkim Key › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Activate Dkim Key › Responses

Successful Response

DkimRecordActivateResponse

object · required

Activated DKIM key status

object

string

Object type

Default: dkim

activated

boolean

Whether the DKIM key was activated

Default: true

Deactivate Dkim Key

POST

https://api.cakemail.dev

/brands/default/dkim/{id}/deactivate

Mark a DKIM key as inactive.

The state is persisted on trust; no DNS lookup is performed.

Required scope(s): dkim:write

Deactivate Dkim Key › path Parameters

id

integer · required

Deactivate Dkim Key › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Deactivate Dkim Key › Responses

Successful Response

DkimRecordDeactivateResponse

object · required

Deactivated DKIM key status

object

string

Object type

Default: dkim

deactivated

boolean

Whether the DKIM key was deactivated

Default: true

Sender Domain