Cakemail API

DKIM

Endpointhttps://api.cakemail.dev

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

object[] · required

List of DKIM keys

GET/brands/default/dkim

curl --request GET \
  --url https://api.cakemail.dev/brands/default/dkim

shell

Example Responses

{
  "data": [
    {
      "id": 0,
      "selector": "selector",
      "domain": "domain",
      "public_key": "public_key",
      "status": "active",
      "account_default": true,
      "domain_default": true
    }
  ]
}

json

application/json

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

domain

string · required

selector

string

Create Dkim Key › Responses

Successful Response

object · required

object

string

Object type

Default: dkim

created

boolean

Whether the DKIM key was created

Default: true

POST/brands/default/dkim

curl --request POST \
  --url https://api.cakemail.dev/brands/default/dkim \
  --header 'Content-Type: application/json' \
  --data '
{
  "selector": "selector",
  "domain": "domain"
}
'

shell

Example Request Body

{
  "selector": "selector",
  "domain": "domain"
}

json

Example Responses

{
  "object": "object",
  "created": true,
  "data": {
    "id": 0,
    "selector": "selector",
    "domain": "domain",
    "public_key": "public_key",
    "status": "active"
  }
}

json

application/json

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

object · required

GET/brands/default/dkim/{id}

curl --request GET \
  --url https://api.cakemail.dev/brands/default/dkim/:id

shell

Example Responses

{
  "data": {
    "id": 0,
    "selector": "selector",
    "domain": "domain",
    "public_key": "public_key",
    "status": "active",
    "account_default": true,
    "domain_default": true,
    "live_dns_status": "valid"
  }
}

json

application/json

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

object · required

object

string

Object type

Default: dkim

deleted

boolean

Whether the DKIM key was deleted

Default: true

DELETE/brands/default/dkim/{id}

curl --request DELETE \
  --url https://api.cakemail.dev/brands/default/dkim/:id

shell

Example Responses

{
  "object": "object",
  "deleted": true,
  "data": {
    "id": 0,
    "selector": "selector",
    "domain": "domain",
    "public_key": "public_key",
    "status": "active"
  }
}

json

application/json

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

object · required

object

string

Object type

Default: dkim

activated

boolean

Whether the DKIM key was activated

Default: true

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

curl --request POST \
  --url https://api.cakemail.dev/brands/default/dkim/:id/activate

shell

Example Responses

{
  "object": "object",
  "activated": true,
  "data": {
    "id": 0,
    "status": "active"
  }
}

json

application/json

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

object · required

object

string

Object type

Default: dkim

deactivated

boolean

Whether the DKIM key was deactivated

Default: true

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

curl --request POST \
  --url https://api.cakemail.dev/brands/default/dkim/:id/deactivate

shell

Example Responses

{
  "object": "object",
  "deactivated": true,
  "data": {
    "id": 0,
    "status": "active"
  }
}

json

application/json

Sender Domain

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

object[] · 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

domain

string · required

selector

string

Create Dkim Key › Responses

Successful Response

object · required

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

object · required

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

object · required

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

object · required

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

object · required

object

string

Object type

Default: dkim

deactivated

boolean

Whether the DKIM key was deactivated

Default: true