Cakemail Logo
Cakemail API

​Transactional Email (1.18.25)

Endpoint:https://api.cakemail.dev
deprecated

​Send an email

POST
https://api.cakemail.dev
/emails

​Send an email › query Parameters

  • account_idinteger · min: 1

​Send an email › Request Body

  • emailstring · email · required
  • senderobject · required
  • contentobject · required
  • group_idinteger · min: 1
  • trackingobject
    Default: {"opens":true,"clicks_html":true,"clicks_text":true}
  • additional_headersobject[]
  • attachment
  • queueinteger · max: 1

​Send an email › Responses

    • emailstring · required
    • dataobject · required
    • objectstring
      Default: email
    • sentboolean
      Default: true

​Show email stats

GET
https://api.cakemail.dev
/reports/emails

​Show email stats › query Parameters

  • start_timeinteger · min: 1 · max: 2147483647 · required
  • end_timeinteger · min: 1 · max: 2147483647 · required
  • account_idinteger · min: 1

​Show email stats › Responses

    • dataobject[] · required
deprecated

​Show email activity logs

GET
https://api.cakemail.dev
/logs/emails

​Show email activity logs › query Parameters

  • log_typestring · enum · required
    Enum values:
    bounce
    clickthru
    sent
    open
    unsubscribe
    resubscribe
    spam
    global_unsubscribe
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647
  • filterstring

​Show email activity logs › Responses

    • paginationobject · required
    • dataobject[] · required
deprecated

​List Email Group Ids

GET
https://api.cakemail.dev
/email-group-ids

​List Email Group Ids › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean

​List Email Group Ids › Responses

    • paginationobject · required
    • dataobject[] · required
deprecated

​Edit an Email Group Id

PATCH
https://api.cakemail.dev
/email-group-ids/{group_id}

​Edit an Email Group Id › path Parameters

  • group_idinteger · required

​Edit an Email Group Id › query Parameters

  • account_idinteger · min: 1

​Edit an Email Group Id › Request Body

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

​Edit an Email Group Id › Responses

    • idinteger · required
    • dataobject · required
    • objectstring
      Default: email-group-id
    • updatedboolean
      Default: true
deprecated

​List Transactional Email Templates

GET
https://api.cakemail.dev
/lists/{list_id}/transactional-email-templates

​List Transactional Email Templates › path Parameters

  • list_idinteger · required

​List Transactional Email Templates › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean

​List Transactional Email Templates › Responses

    • paginationobject · required
    • dataobject[] · required
deprecated

​Create a Transactional Email Template

POST
https://api.cakemail.dev
/lists/{list_id}/transactional-email-templates

​Create a Transactional Email Template › path Parameters

  • list_idinteger · required

​Create a Transactional Email Template › query Parameters

  • account_idinteger · min: 1

​Create a Transactional Email Template › Request Body

  • namestring · required
  • senderobject · required
  • contentrequired
  • reply_tostring · email
  • ccstring[] · maxItems: 1
  • trackingobject

​Create a Transactional Email Template › Responses

    • idinteger · required
    • dataobject · required
    • objectstring
      Default: transactional-email-template
    • createdboolean
      Default: true
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 › path Parameters

  • list_idinteger · required
  • transactional_email_template_idinteger · required

​Show a Transactional Email Template › query Parameters

  • account_idinteger

​Show a Transactional Email Template › Responses

    • dataobject · required
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 › path Parameters

  • list_idinteger · required
  • transactional_email_template_idinteger · required

​Delete a Transactional Email Template › query Parameters

  • account_idinteger · min: 1

​Delete a Transactional Email Template › Responses

    • idinteger · required
    • dataobject · required
    • objectstring
      Default: transactional-email-template
    • deletedboolean
      Default: true
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 › path Parameters

  • list_idinteger · required
  • transactional_email_template_idinteger · required

​Update a Transactional Email Template › query Parameters

  • account_idinteger · min: 1

​Update a Transactional Email Template › Request Body

  • namestring
  • senderobject
  • reply_tostring · email
  • ccstring[] · maxItems: 1
  • content
  • trackingobject

​Update a Transactional Email Template › Responses

    • idinteger · required
    • dataobject · required
    • objectstring
      Default: transactional-email-template
    • updatedboolean
      Default: true
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 contact › path Parameters

  • list_idinteger · required
  • transactional_email_template_idinteger · required

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

  • account_idinteger

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

  • contact_idinteger · required
  • senderobject
  • custom_attributesobject[]
  • attachmentsobject[]
  • resubscribeboolean
  • queueinteger · max: 1
  • emailstring · email · required
  • senderobject
  • custom_attributesobject[]
  • attachmentsobject[]
  • resubscribeboolean
  • queueinteger · max: 1

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

    • emailstring · required
    • dataobject · required
    • objectstring
      Default: transactional-email-template
    • sentboolean
      Default: true
    • emailstring · required
    • dataobject · required
    • objectstring
      Default: email
    • sentboolean
      Default: true
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 › path Parameters

  • list_idinteger · required
  • transactional_email_template_idinteger · required

​Send a Test Transactional Email from a Template › query Parameters

  • account_idinteger · min: 1

​Send a Test Transactional Email from a Template › Request Body

  • emailstring · email · required

​Send a Test Transactional Email from a Template › Responses

    • objectstring
      Default: transactional-email-test
    • sentboolean
      Default: true
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 › path Parameters

  • list_idinteger · required
  • transactional_email_template_idinteger · required

​Render a Transactional Email Template › query Parameters

  • account_idinteger

​Render a Transactional Email Template › Request Body

  • contact_idinteger · required
  • custom_attributesobject[]

​Render a Transactional Email Template › Responses

    string
DomainEmail API