Cakemail Logo
Cakemail API

​Email API (1.18.25)

Endpoint:https://api.cakemail.dev

​Submit an email

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

​Submit an email › query Parameters

  • account_idinteger · min: 1

​Submit an email › Request Body

  • senderobject · required
  • contentobject · required
  • emailstring · email
  • list_idinteger · min: 1
  • contact_idinteger · min: 1
  • tagsstring[] · minLength: 1 · maxLength: 255 · pattern: ^[a-zA-Z0-9-_]+$
  • trackingobject
  • additional_headersobject[]
  • attachment

​Submit an email › Responses

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

​Retrieve a submitted email

GET
https://api.cakemail.dev
/v2/emails/{email_id}

​Retrieve a submitted email › path Parameters

  • email_idstring · uuid · required

​Retrieve a submitted email › query Parameters

  • account_idinteger · min: 1

​Retrieve a submitted email › Responses

    • email_idstring · uuid · required
    • statusstring · enum · required
      Enum values:
      submitted
      processing
      click
      open
      bounce
      spam
      unsubscribe
      unsubscribe_reason
    • emailstring · required
    • submitted_timeinteger · required
    • senderobject · required
    • contentobject · required
    • trackingobject · required
    • providerstring
    • unsubscribedboolean
    • global_unsubscribedboolean
    • soft_bouncedboolean
    • hard_bouncedboolean
    • reported_as_spamboolean
    • openinteger
    • clickinteger
    • list_idinteger
    • tagsstring[]
    • additional_headersobject[]
    • thumbnail_urlstring

​Render a submitted email

GET
https://api.cakemail.dev
/v2/emails/{email_id}/render

​Render a submitted email › path Parameters

  • email_idstring · uuid · required

​Render a submitted email › query Parameters

  • as_submittedboolean
  • trackingboolean
  • account_idinteger · min: 1

​Render a submitted email › Responses

    string

​List Email Tags

GET
https://api.cakemail.dev
/email-tags

​List Email Tags › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
    Default: true
  • namestring
    Example: tag1~~tag

​List Email Tags › Responses

    • paginationobject · required
    • datastring[] · required

​Show Email API activity logs

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

​Show Email API activity logs › query Parameters

  • log_typestring · enum
    Enum values:
    all
    submitted
    rejected
    error
    queued
    delivered
    open
    click
    Default: all
  • email_idstring · uuid
  • iso_timeboolean
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1 · max: 100
    Default: 50
  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647
  • tagsstring
  • providersstring
  • sortstring
    Default: -time

​Show Email API activity logs › Responses

    • paginationobject · required
    • parametersobject · required
    • dataobject[] · required

​Show Email API activity summary

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

​Show Email API activity summary › query Parameters

  • email_idstring · uuid
  • engagementstring · enum
    Enum values:
    click
    open
    none
    open_not_click
  • statusstring · enum
    Enum values:
    submitted
    delivered
    queued
    rejected
    error
    bounced
    spam
    unsubscribed
  • iso_timeboolean
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1 · max: 100
    Default: 50
  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647
  • tagsstring
  • providersstring
  • sortstring
    Default: -submitted_time
  • emailstring
    Example: localpart@domain.com

​Show Email API activity summary › Responses

    • paginationobject · required
    • parametersobject · required
    • dataobject[] · required

​Show Email API statistics

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

​Show Email API statistics › query Parameters

  • intervalstring · enum
    Enum values:
    5m
    15m
    30m
    1h
    1d
  • iso_timeboolean
  • account_idinteger · min: 1
  • start_timeinteger · min: 1 · max: 2147483647
  • end_timeinteger · min: 1 · max: 2147483647
  • providersstring
  • tagsstring

​Show Email API statistics › Responses

    • parametersobject · required
    • dataobject[] · required
Transactional EmailForm