Cakemail Logo
Cakemail API

​Campaign (1.18.25)

Endpoint:https://api.cakemail.dev

​Show all campaigns

GET
https://api.cakemail.dev
/campaigns

​Show all campaigns › query Parameters

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

​Show all campaigns › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a campaign

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

​Create a campaign › query Parameters

  • account_idinteger · min: 1

​Create a campaign › Request Body

  • namestring · minLength: 1 · required
  • audienceobject
    Default: {}
  • trackingobject
    Default: {"opens":true,"clicks_html":true,"clicks_text":true}
  • senderobject
  • reply_to_emailstring · email
  • contentobject
    Default: {"type":"html"}

​Create a campaign › Responses

    • idinteger · required
    • dataobject · required
    • objectstring
      Default: campaign
    • createdboolean
      Default: true

​Show a campaign details

GET
https://api.cakemail.dev
/campaigns/{campaign_id}

​Show a campaign details › path Parameters

  • campaign_idinteger · required

​Show a campaign details › query Parameters

  • revision_idinteger
  • account_idinteger · min: 1

​Show a campaign details › Responses

    • dataobject · required

​Delete a campaign

DELETE
https://api.cakemail.dev
/campaigns/{campaign_id}

​Delete a campaign › path Parameters

  • campaign_idinteger · required

​Delete a campaign › query Parameters

  • account_idinteger · min: 1

​Delete a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • deletedboolean
      Default: true

​Update a campaign

PATCH
https://api.cakemail.dev
/campaigns/{campaign_id}

​Update a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Update a campaign › query Parameters

  • account_idinteger · min: 1

​Update a campaign › Request Body

  • namestring · minLength: 1
  • audienceobject
    Default: {}
  • trackingobject
  • senderobject
  • reply_to_emailstring · email
  • contentobject
    Default: {}

​Update a campaign › Responses

    • idinteger · required
    • dataobject · required
    • objectstring
      Default: campaign
    • updatedboolean
      Default: true

​Render a campaign

GET
https://api.cakemail.dev
/campaigns/{campaign_id}/render

​Render a campaign › path Parameters

  • campaign_idinteger · required

​Render a campaign › query Parameters

  • contact_idinteger · min: 1
  • account_idinteger · min: 1

​Render a campaign › Responses

    • dataobject · required

​Send a test email

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/send-test

​Send a test email › path Parameters

  • campaign_idinteger · min: 1 · required

​Send a test email › query Parameters

  • account_idinteger · min: 1

​Send a test email › Request Body

  • emailstring · email · required
  • typestring · enum
    Enum values:
    merged
    separated
    Default: merged

​Send a test email › Responses

    • emailstring · email · required
    • typestring · enum · required
      Enum values:
      merged
      separated
    • objectstring
      Default: test_email
    • sentboolean
      Default: true

​Schedule a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/schedule

​Schedule a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Schedule a campaign › query Parameters

  • account_idinteger · min: 1

​Schedule a campaign › Request Body

  • dateinteger · min: 1 · max: 2147483647
  • html_emptyboolean

​Schedule a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • scheduledboolean
      Default: true

​Unschedule a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/unschedule

​Unschedule a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Unschedule a campaign › query Parameters

  • account_idinteger · min: 1

​Unschedule a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • scheduledboolean
      Default: true

​Reschedule a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/reschedule

​Reschedule a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Reschedule a campaign › query Parameters

  • account_idinteger · min: 1

​Reschedule a campaign › Request Body

  • dateinteger · min: 1 · max: 2147483647
  • html_emptyboolean

​Reschedule a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • scheduledboolean
      Default: true

​Suspend a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/suspend

​Suspend a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Suspend a campaign › query Parameters

  • account_idinteger · min: 1

​Suspend a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • suspendedboolean
      Default: true

​Resume a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/resume

​Resume a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Resume a campaign › query Parameters

  • account_idinteger · min: 1

​Resume a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • resumedboolean
      Default: true

​Cancel a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/cancel

​Cancel a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Cancel a campaign › query Parameters

  • account_idinteger · min: 1

​Cancel a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • cancelledboolean
      Default: true

​Archive a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/archive

​Archive a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Archive a campaign › query Parameters

  • account_idinteger · min: 1

​Archive a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • archivedboolean
      Default: true

​Unarchive a campaign

POST
https://api.cakemail.dev
/campaigns/{campaign_id}/unarchive

​Unarchive a campaign › path Parameters

  • campaign_idinteger · min: 1 · required

​Unarchive a campaign › query Parameters

  • account_idinteger · min: 1

​Unarchive a campaign › Responses

    • idinteger · required
    • objectstring
      Default: campaign
    • archivedboolean
      Default: true

​Show all campaign revisions

GET
https://api.cakemail.dev
/campaigns/{campaign_id}/revisions

​Show all campaign revisions › path Parameters

  • campaign_idinteger · required

​Show all campaign revisions › query Parameters

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

​Show all campaign revisions › Responses

    • paginationobject · required
    • dataobject[] · required

​Show a campaign links

GET
https://api.cakemail.dev
/campaigns/{campaign_id}/links

​Show a campaign links › path Parameters

  • campaign_idinteger · required

​Show a campaign links › query Parameters

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

​Show a campaign links › Responses

    • paginationobject · required
    • dataobject[] · required
ActionCampaign Blueprint