Cakemail API

Transactional Email

Endpointhttps://api.cakemail.dev

Send transactional emails using templates. Transactional emails are one-to-one messages triggered by user actions (order confirmations, password resets, notifications). Create reusable templates with merge tags, then send them to individual contacts. Includes deprecated template-based endpoints — for new integrations, use the Email API.

deprecated

Send an email

POST

https://api.cakemail.dev

/emails

Required scope(s): emailapi:read

Send an email › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Send an email › Request Body

email

string · email · required

Recipient's email address

object · required

group_id

integer · min: 1

Allows the grouping multiple transactional emails for analytics

object

object[]

Custom mail headers

One or more file attachments

queue

integer · min: 0 · max: 1

Queue ID

Default: 0

Send an email › Responses

Successful Response

email

string · required

Recipient email address

object · required

object

string

Object type

Default: email

sent

boolean

Whether the email was sent

Default: true

POST/emails

curl --request POST \
  --url https://api.cakemail.dev/emails \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "test@example.com",
  "group_id": 0,
  "tracking": {
    "opens": true,
    "clicks_html": true,
    "clicks_text": true
  },
  "sender": {
    "id": "id",
    "name": "name"
  },
  "additional_headers": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "attachment": {
    "filename": "filename",
    "type": "csv",
    "content": "content"
  },
  "content": {
    "subject": "subject",
    "html": "html",
    "text": "text",
    "template": {
      "id": 0,
      "custom_attributes": [
        {
          "name": "name",
          "value": "value"
        }
      ]
    },
    "encoding": "utf-8",
    "custom_attributes": [
      {
        "name": "name",
        "value": "value"
      }
    ]
  },
  "queue": 0
}
'

shell

Example Request Body

{
  "email": "test@example.com",
  "group_id": 0,
  "tracking": {
    "opens": true,
    "clicks_html": true,
    "clicks_text": true
  },
  "sender": {
    "id": "id",
    "name": "name"
  },
  "additional_headers": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "attachment": {
    "filename": "filename",
    "type": "csv",
    "content": "content"
  },
  "content": {
    "subject": "subject",
    "html": "html",
    "text": "text",
    "template": {
      "id": 0,
      "custom_attributes": [
        {
          "name": "name",
          "value": "value"
        }
      ]
    },
    "encoding": "utf-8",
    "custom_attributes": [
      {
        "name": "name",
        "value": "value"
      }
    ]
  },
  "queue": 0
}

json

Example Responses

{
  "email": "email",
  "object": "object",
  "sent": true,
  "data": {
    "id": 0
  }
}

json

application/json

Show email stats

GET

https://api.cakemail.dev

/reports/emails

Get aggregated email statistics for the legacy email system, including send counts, opens, clicks, and bounces over a time period.

Required scope(s): reports:read

Show email stats › query Parameters

start_time

integer · min: 1 · max: 2147483647 · required

Start time for the report.

end_time

integer · min: 1 · max: 2147483647 · required

End time for the report.

account_id

integer · min: 1

Optional Account ID to be used for the request

Show email stats › Responses

Successful Response

object[] · required

Email statistics per date

GET/reports/emails

curl --request GET \
  --url 'https://api.cakemail.dev/reports/emails?start_time=%3Cnumber%3E&end_time=%3Cnumber%3E'

shell

Example Responses

{
  "data": [
    {
      "date": 0,
      "sent_emails": 0,
      "open_rate": 0,
      "bounce_rate": 0,
      "click_rate": 0,
      "spam_rate": 0
    }
  ]
}

json

application/json

deprecated

Show email activity logs

GET

https://api.cakemail.dev

/logs/emails

Required scope(s): logs:read

Show email activity logs › query Parameters

log_type

string · enum · required

An enumeration.

Enum values:

bounce

clickthru

sent

open

unsubscribe

resubscribe

spam

global_unsubscribe

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

start_time

integer · min: 1 · max: 2147483647

Start time for the report.

end_time

integer · min: 1 · max: 2147483647

End time for the report.

filter

string

Valid Terms:

group_id
email
email_id

Valid Operators:

==

Query separator:

Valid Terms:

group_id
email
email_id

Valid Operators:

==

Query separator:

Show email activity logs › Responses

Successful Response

object · required

object[] · required

List of email log entries

GET/logs/emails

curl --request GET \
  --url 'https://api.cakemail.dev/logs/emails?log_type=%3Cstring%3E'

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "type": "clickthru",
      "timestamp": 0,
      "email": "email",
      "email_id": 0,
      "group_id": 0,
      "user_agent": {
        "ip": "ip",
        "os": {
          "family": "family",
          "version": "version"
        },
        "browser": {
          "family": "family",
          "version": "version"
        },
        "device": {
          "family": "pc",
          "brand": "brand",
          "model": "model"
        },
        "is_bot": true,
        "raw": "raw"
      },
      "clickthru_url": "clickthru_url",
      "dsn_message": "dsn_message",
      "sender_name": "sender_name",
      "sender_email": "sender_email",
      "source_ip": "source_ip",
      "envelope_from": "envelope_from",
      "additional_headers": [
        {
          "name": "name",
          "value": "value"
        }
      ]
    }
  ]
}

json

application/json

deprecated

List Email Group Ids

GET

https://api.cakemail.dev

/email-group-ids

List Email Group Ids › 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

List Email Group Ids › Responses

Successful Response

object · required

object[] · required

List of email group ids

GET/email-group-ids

curl --request GET \
  --url https://api.cakemail.dev/email-group-ids

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "description": "description"
    }
  ]
}

json

application/json

deprecated

Edit an Email Group Id

PATCH

https://api.cakemail.dev

/email-group-ids/{group_id}

Edit an Email Group Id › path Parameters

group_id

integer · required

The ID of the group to edit

Edit an Email Group Id › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Edit an Email Group Id › Request Body

description

string · maxLength: 255 · pattern: ^[\w\s!@#$%^&*()_+\-… · required

Edit an Email Group Id › Responses

Successful Response

id

integer · required

Email group id

object · required

object

string

Object type

Default: email-group-id

updated

boolean

Whether the email group id was updated

Default: true

PATCH/email-group-ids/{group_id}

curl --request PATCH \
  --url https://api.cakemail.dev/email-group-ids/:group_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "description"
}
'

shell

Example Request Body

{
  "description": "description"
}

json

Example Responses

{
  "id": 0,
  "object": "object",
  "updated": true,
  "data": {
    "id": 0,
    "description": "description"
  }
}

json

application/json

deprecated

List Transactional Email Templates

GET

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates

List Transactional Email Templates

Required scope(s): transactional:read

List Transactional Email Templates › path Parameters

list_id

integer · required

List Transactional Email Templates › 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

List Transactional Email Templates › Responses

Successful Response

object · required

object[] · required

GET/lists/{list_id}/transactional-email-templates

curl --request GET \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "name": "name",
      "status": "status",
      "created_on": 0,
      "sender": {
        "name": "name",
        "email": "email"
      },
      "content": {
        "subject": "subject",
        "type": "custom"
      },
      "thumbnail_url": "thumbnail_url"
    }
  ]
}

json

application/json

deprecated

Create a Transactional Email Template

POST

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates

Create a Transactional Email Template

Required scope(s): transactional:write

Create a Transactional Email Template › path Parameters

list_id

integer · required

Create a Transactional Email Template › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Create a Transactional Email Template › Request Body

name

string · required

object · required

required

reply_to

string · email

cc

string[] · maxItems: 1

object

Create a Transactional Email Template › Responses

Successful Response

id

integer · required

object · required

object

string

Default: transactional-email-template

created

boolean

Default: true

POST/lists/{list_id}/transactional-email-templates

curl --request POST \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "sender": {
    "id": "id"
  },
  "reply_to": "test@example.com",
  "cc": [
    "test@example.com"
  ],
  "content": {
    "type": "custom",
    "subject": "subject",
    "json": {},
    "html": "html"
  },
  "tracking": {
    "additional_params": "additional_params"
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "sender": {
    "id": "id"
  },
  "reply_to": "test@example.com",
  "cc": [
    "test@example.com"
  ],
  "content": {
    "type": "custom",
    "subject": "subject",
    "json": {},
    "html": "html"
  },
  "tracking": {
    "additional_params": "additional_params"
  }
}

json

Example Responses

{
  "id": 0,
  "object": "object",
  "created": true,
  "data": {
    "id": 0,
    "name": "name",
    "status": "status",
    "created_on": 0,
    "updated_on": 0,
    "cc": [
      "string"
    ],
    "reply_to": "reply_to",
    "sender": {
      "name": "name",
      "email": "email"
    },
    "content": {
      "type": "custom",
      "subject": "subject",
      "json": {},
      "html": "html"
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Show a Transactional Email Template

GET

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}

Show a Transactional Email Template

Required scope(s): transactional:read

Show a Transactional Email Template › path Parameters

list_id

integer · required

transactional_email_template_id

integer · required

Show a Transactional Email Template › query Parameters

account_id

integer

Show a Transactional Email Template › Responses

Successful Response

object · required

GET/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}

curl --request GET \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates/:transactional_email_template_id

shell

Example Responses

{
  "data": {
    "id": 0,
    "name": "name",
    "status": "status",
    "created_on": 0,
    "updated_on": 0,
    "cc": [
      "string"
    ],
    "reply_to": "reply_to",
    "sender": {
      "name": "name",
      "email": "email"
    },
    "content": {
      "type": "custom",
      "subject": "subject",
      "json": {},
      "html": "html"
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Delete a Transactional Email Template

DELETE

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}

Delete a Transactional Email Template

Required scope(s): transactional:delete

Delete a Transactional Email Template › path Parameters

list_id

integer · required

transactional_email_template_id

integer · required

Delete a Transactional Email Template › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Delete a Transactional Email Template › Responses

Successful Response

id

integer · required

object · required

object

string

Default: transactional-email-template

deleted

boolean

Default: true

DELETE/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}

curl --request DELETE \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates/:transactional_email_template_id

shell

Example Responses

{
  "id": 0,
  "object": "object",
  "deleted": true,
  "data": {
    "id": 0,
    "name": "name",
    "status": "status",
    "created_on": 0,
    "updated_on": 0,
    "cc": [
      "string"
    ],
    "reply_to": "reply_to",
    "sender": {
      "name": "name",
      "email": "email"
    },
    "content": {
      "type": "custom",
      "subject": "subject",
      "json": {},
      "html": "html"
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Update a Transactional Email Template

PATCH

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}

Update a Transactional Email Template

Required scope(s): transactional:write

Update a Transactional Email Template › path Parameters

list_id

integer · required

transactional_email_template_id

integer · required

Update a Transactional Email Template › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Update a Transactional Email Template › Request Body

name

string

object

reply_to

string · email

cc

string[] · maxItems: 1

object

Update a Transactional Email Template › Responses

Successful Response

id

integer · required

object · required

object

string

Default: transactional-email-template

updated

boolean

Default: true

PATCH/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}

curl --request PATCH \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates/:transactional_email_template_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "sender": {
    "id": "id"
  },
  "reply_to": "test@example.com",
  "cc": [
    "test@example.com"
  ],
  "content": {
    "type": "custom",
    "subject": "subject",
    "json": {},
    "html": "html"
  },
  "tracking": {
    "additional_params": "additional_params"
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "sender": {
    "id": "id"
  },
  "reply_to": "test@example.com",
  "cc": [
    "test@example.com"
  ],
  "content": {
    "type": "custom",
    "subject": "subject",
    "json": {},
    "html": "html"
  },
  "tracking": {
    "additional_params": "additional_params"
  }
}

json

Example Responses

{
  "id": 0,
  "object": "object",
  "updated": true,
  "data": {
    "id": 0,
    "name": "name",
    "status": "status",
    "created_on": 0,
    "updated_on": 0,
    "cc": [
      "string"
    ],
    "reply_to": "reply_to",
    "sender": {
      "name": "name",
      "email": "email"
    },
    "content": {
      "type": "custom",
      "subject": "subject",
      "json": {},
      "html": "html"
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Send a Transactional Email from a Template to a contact

POST

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/send

Send a Transactional Email from a Template to a single contact in the list.

If you need to send to multiple contacts at once, you should use the Campaigns API, which are designed for bulk sending.

Required scope(s): transactional:send

Send a Transactional Email from a Template to a contact › path Parameters

list_id

integer · required

transactional_email_template_id

integer · required

Send a Transactional Email from a Template to a contact › query Parameters

account_id

integer

Send a Transactional Email from a Template to a contact › Request Body

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: contact_id
	type = object · requires: email

Properties for SendTransactionalEmailToContactId:

contact_id

integer · required

object

object[]

List of temporary custom attributes, overriding the contact's custom attributes. Note: the custom attributes will not be saved to the contact's profile.

object[]

resubscribe

boolean

Default: false

queue

integer · min: 0 · max: 1

Queue ID

Default: 0

Send a Transactional Email from a Template to a contact › Responses

Successful Response

anyOf

At least one variant must match. Multiple variants may match simultaneously.

Decision Table

Variant	Matching Criteria
	type = object · requires: email, data
	type = object · requires: email, data

Properties for SendTransactionalEmailTemplateResponse:

email

string · required

object · required

object

string

Default: transactional-email-template

sent

boolean

Default: true

POST/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/send

curl --request POST \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates/:transactional_email_template_id/send \
  --header 'Content-Type: application/json' \
  --data '
{
  "sender": {
    "id": "id",
    "name": "name"
  },
  "custom_attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "attachments": [
    {
      "filename": "filename",
      "type": "csv",
      "content": "content"
    }
  ],
  "resubscribe": true,
  "queue": 0,
  "contact_id": 0
}
'

shell

Example Request Body

{
  "sender": {
    "id": "id",
    "name": "name"
  },
  "custom_attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ],
  "attachments": [
    {
      "filename": "filename",
      "type": "csv",
      "content": "content"
    }
  ],
  "resubscribe": true,
  "queue": 0,
  "contact_id": 0
}

json

Example Responses

{
  "email": "email",
  "object": "object",
  "sent": true,
  "data": {
    "contact_id": 0
  }
}

json

application/json

deprecated

Send a Test Transactional Email from a Template

POST

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/send-test

Send a Test Transactional Email from a Template

Required scope(s): transactional:send-test

Send a Test Transactional Email from a Template › path Parameters

list_id

integer · required

transactional_email_template_id

integer · required

Send a Test Transactional Email from a Template › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Send a Test Transactional Email from a Template › Request Body

email

string · email · required

Send a Test Transactional Email from a Template › Responses

Successful Response

object

string

Default: transactional-email-test

sent

boolean

Default: true

POST/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/send-test

curl --request POST \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates/:transactional_email_template_id/send-test \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "test@example.com"
}
'

shell

Example Request Body

{
  "email": "test@example.com"
}

json

Example Responses

{
  "object": "object",
  "sent": true
}

json

application/json

deprecated

Render a Transactional Email Template

POST

https://api.cakemail.dev

/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/render

Render a Transactional Email Template

Required scope(s): transactional:read

Render a Transactional Email Template › path Parameters

list_id

integer · required

transactional_email_template_id

integer · required

Render a Transactional Email Template › query Parameters

account_id

integer

Render a Transactional Email Template › Request Body

contact_id

integer · required

object[]

Render a Transactional Email Template › Responses

Successful Response

string

POST/lists/{list_id}/transactional-email-templates/{transactional_email_template_id}/render

curl --request POST \
  --url https://api.cakemail.dev/lists/:list_id/transactional-email-templates/:transactional_email_template_id/render \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": 0,
  "custom_attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}
'

shell

Example Request Body

{
  "contact_id": 0,
  "custom_attributes": [
    {
      "name": "name",
      "value": "value"
    }
  ]
}

json

Example Responses

string

html

text/html

Template Email API