Cakemail API

Sender

Endpointhttps://api.cakemail.dev

Manage sender identities (name and email pairs) used as the 'From' address in campaigns and transactional emails. New senders require email confirmation before use.

Show all senders

GET

https://api.cakemail.dev

/brands/default/senders

List all sender identities configured for the account, including their confirmation status.

Required scope(s): senders:read

Show all senders › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
email
confirmed

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
email
confirmed

Show all senders › Responses

Successful Response

object · required

object[] · required

List of senders

GET/brands/default/senders

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

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "name": "name",
      "email": "email",
      "confirmed": true,
      "confirmed_on": 0,
      "language": "da",
      "last_confirmation_sent_on": 0
    }
  ]
}

json

application/json

Add a sender

POST

https://api.cakemail.dev

/brands/default/senders

Add a new sender identity. A confirmation email is sent to the specified email address. The sender cannot be used until the email is confirmed.

Required scope(s): senders:write

Add a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Add a sender › Request Body

name

string · minLength: 1 · required

Display name of the sender

email

string · email · required

Email address of the sender

language

string · enum

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

Add a sender › Responses

Successful Response

id

string · required

Unique identifier of the created sender

object · required

created

boolean

Whether the sender was created

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders

curl --request POST \
  --url https://api.cakemail.dev/brands/default/senders \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "email": "test@example.com",
  "language": "da"
}
'

shell

Example Request Body

{
  "name": "name",
  "email": "test@example.com",
  "language": "da"
}

json

Example Responses

{
  "id": "id",
  "created": true,
  "object": "object",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Show a sender details

GET

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Retrieve the details of a sender identity, including name, email, and confirmation status.

Required scope(s): senders:read

Show a sender details › path Parameters

sender_id

string · required

Show a sender details › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show a sender details › Responses

Successful Response

object · required

GET/brands/default/senders/{sender_id}

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

shell

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Delete a sender

DELETE

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Delete a sender identity. Senders currently in use by active campaigns cannot be deleted.

Required scope(s): senders:delete

Delete a sender › path Parameters

sender_id

string · required

Delete a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a sender › Responses

Successful Response

id

string · required

Unique identifier of the deleted sender

deleted

boolean

Whether the sender was deleted

Default: true

object

string

Object type

Default: sender

DELETE/brands/default/senders/{sender_id}

curl --request DELETE \
  --url https://api.cakemail.dev/brands/default/senders/:sender_id

shell

Example Responses

{
  "id": "id",
  "deleted": true,
  "object": "object"
}

json

application/json

Update a sender

PATCH

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Update a sender's name. Changing the email address requires creating a new sender.

Required scope(s): senders:write

Update a sender › path Parameters

sender_id

string · required

Update a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Update a sender › Request Body

name

string

Display name of the sender

language

string · enum

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

Update a sender › Responses

Successful Response

id

string · required

Unique identifier of the updated sender

object · required

updated

boolean

Whether the sender was updated

Default: true

object

string

Object type

Default: sender

PATCH/brands/default/senders/{sender_id}

curl --request PATCH \
  --url https://api.cakemail.dev/brands/default/senders/:sender_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "language": "da"
}
'

shell

Example Request Body

{
  "name": "name",
  "language": "da"
}

json

Example Responses

{
  "id": "id",
  "updated": true,
  "object": "object",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Confirm a sender

POST

https://api.cakemail.dev

/brands/default/senders/confirm-email

Confirm a sender's email address using the token received in the confirmation email.

Required scope(s): senders:write

Confirm a sender › Request Body

confirmation_id

string · minLength: 1 · required

Confirmation token from the verification email

Confirm a sender › Responses

Successful Response

object · required

confirmed

boolean

Whether the sender was confirmed

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders/confirm-email

curl --request POST \
  --url https://api.cakemail.dev/brands/default/senders/confirm-email \
  --header 'Content-Type: application/json' \
  --data '
{
  "confirmation_id": "confirmation_id"
}
'

shell

Example Request Body

{
  "confirmation_id": "confirmation_id"
}

json

Example Responses

{
  "confirmed": true,
  "object": "object",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Resend confirmation email

POST

https://api.cakemail.dev

/brands/default/senders/{sender_id}/resend-confirmation-email

Resend the confirmation email for an unconfirmed sender.

Required scope(s): senders:write

Resend confirmation email › path Parameters

sender_id

string · required

Resend confirmation email › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Resend confirmation email › Responses

Successful Response

id

string · required

Unique identifier of the sender

resent

boolean

Whether the confirmation email was resent

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders/{sender_id}/resend-confirmation-email

curl --request POST \
  --url https://api.cakemail.dev/brands/default/senders/:sender_id/resend-confirmation-email

shell

Example Responses

{
  "id": "id",
  "resent": true,
  "object": "object"
}

json

application/json

Email API DKIM

Cakemail API

Sender

Endpointhttps://api.cakemail.dev

Manage sender identities (name and email pairs) used as the 'From' address in campaigns and transactional emails. New senders require email confirmation before use.

Show all senders

GET

https://api.cakemail.dev

/brands/default/senders

List all sender identities configured for the account, including their confirmation status.

Required scope(s): senders:read

Show all senders › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
email
confirmed

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
email
confirmed

Show all senders › Responses

Successful Response

object · required

object[] · required

List of senders

GET/brands/default/senders

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

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "name": "name",
      "email": "email",
      "confirmed": true,
      "confirmed_on": 0,
      "language": "da",
      "last_confirmation_sent_on": 0
    }
  ]
}

json

application/json

Add a sender

POST

https://api.cakemail.dev

/brands/default/senders

Add a new sender identity. A confirmation email is sent to the specified email address. The sender cannot be used until the email is confirmed.

Required scope(s): senders:write

Add a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Add a sender › Request Body

name

string · minLength: 1 · required

Display name of the sender

email

string · email · required

Email address of the sender

language

string · enum

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

Add a sender › Responses

Successful Response

id

string · required

Unique identifier of the created sender

object · required

created

boolean

Whether the sender was created

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders

curl --request POST \
  --url https://api.cakemail.dev/brands/default/senders \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "email": "test@example.com",
  "language": "da"
}
'

shell

Example Request Body

{
  "name": "name",
  "email": "test@example.com",
  "language": "da"
}

json

Example Responses

{
  "id": "id",
  "created": true,
  "object": "object",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Show a sender details

GET

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Retrieve the details of a sender identity, including name, email, and confirmation status.

Required scope(s): senders:read

Show a sender details › path Parameters

sender_id

string · required

Show a sender details › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Show a sender details › Responses

Successful Response

object · required

GET/brands/default/senders/{sender_id}

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

shell

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Delete a sender

DELETE

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Delete a sender identity. Senders currently in use by active campaigns cannot be deleted.

Required scope(s): senders:delete

Delete a sender › path Parameters

sender_id

string · required

Delete a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a sender › Responses

Successful Response

id

string · required

Unique identifier of the deleted sender

deleted

boolean

Whether the sender was deleted

Default: true

object

string

Object type

Default: sender

DELETE/brands/default/senders/{sender_id}

curl --request DELETE \
  --url https://api.cakemail.dev/brands/default/senders/:sender_id

shell

Example Responses

{
  "id": "id",
  "deleted": true,
  "object": "object"
}

json

application/json

Update a sender

PATCH

https://api.cakemail.dev

/brands/default/senders/{sender_id}

Update a sender's name. Changing the email address requires creating a new sender.

Required scope(s): senders:write

Update a sender › path Parameters

sender_id

string · required

Update a sender › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Update a sender › Request Body

name

string

Display name of the sender

language

string · enum

Supported Locales

Enum values:

da_DK

de_DE

el_GR

en_US

Update a sender › Responses

Successful Response

id

string · required

Unique identifier of the updated sender

object · required

updated

boolean

Whether the sender was updated

Default: true

object

string

Object type

Default: sender

PATCH/brands/default/senders/{sender_id}

curl --request PATCH \
  --url https://api.cakemail.dev/brands/default/senders/:sender_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "language": "da"
}
'

shell

Example Request Body

{
  "name": "name",
  "language": "da"
}

json

Example Responses

{
  "id": "id",
  "updated": true,
  "object": "object",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Confirm a sender

POST

https://api.cakemail.dev

/brands/default/senders/confirm-email

Confirm a sender's email address using the token received in the confirmation email.

Required scope(s): senders:write

Confirm a sender › Request Body

confirmation_id

string · minLength: 1 · required

Confirmation token from the verification email

Confirm a sender › Responses

Successful Response

object · required

confirmed

boolean

Whether the sender was confirmed

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders/confirm-email

curl --request POST \
  --url https://api.cakemail.dev/brands/default/senders/confirm-email \
  --header 'Content-Type: application/json' \
  --data '
{
  "confirmation_id": "confirmation_id"
}
'

shell

Example Request Body

{
  "confirmation_id": "confirmation_id"
}

json

Example Responses

{
  "confirmed": true,
  "object": "object",
  "data": {
    "id": "id",
    "name": "name",
    "email": "email",
    "confirmed": true,
    "confirmed_on": 0,
    "language": "da",
    "last_confirmation_sent_on": 0
  }
}

json

application/json

Resend confirmation email

POST

https://api.cakemail.dev

/brands/default/senders/{sender_id}/resend-confirmation-email

Resend the confirmation email for an unconfirmed sender.

Required scope(s): senders:write

Resend confirmation email › path Parameters

sender_id

string · required

Resend confirmation email › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Resend confirmation email › Responses

Successful Response

id

string · required

Unique identifier of the sender

resent

boolean

Whether the confirmation email was resent

Default: true

object

string

Object type

Default: sender

POST/brands/default/senders/{sender_id}/resend-confirmation-email

curl --request POST \
  --url https://api.cakemail.dev/brands/default/senders/:sender_id/resend-confirmation-email

shell

Example Responses

{
  "id": "id",
  "resent": true,
  "object": "object"
}

json

application/json

Email API DKIM