Cakemail Logo
Cakemail API

Campaign (1.18.25)

Endpoint:https://api.cakemail.dev

Show all campaigns

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

Show all campaignsquery Parameters

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

Show all campaignsResponses

    • paginationobject · required
    • dataobject[] · required

Create a campaign

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

Create a campaignquery Parameters

  • account_idinteger · min: 1

Create a campaignRequest 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 campaignResponses

    • 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 detailspath Parameters

  • campaign_idinteger · required

Show a campaign detailsquery Parameters

  • revision_idinteger
  • account_idinteger · min: 1

Show a campaign detailsResponses

    • dataobject · required

Delete a campaign

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

Delete a campaignpath Parameters

  • campaign_idinteger · required

Delete a campaignquery Parameters

  • account_idinteger · min: 1

Delete a campaignResponses

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

Update a campaign

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

Update a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Update a campaignquery Parameters

  • account_idinteger · min: 1

Update a campaignRequest Body

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

Update a campaignResponses

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

Render a campaign

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

Render a campaignpath Parameters

  • campaign_idinteger · required

Render a campaignquery Parameters

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

Render a campaignResponses

    • dataobject · required

Send a test email

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

Send a test emailpath Parameters

  • campaign_idinteger · min: 1 · required

Send a test emailquery Parameters

  • account_idinteger · min: 1

Send a test emailRequest Body

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

Send a test emailResponses

    • 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 campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Schedule a campaignquery Parameters

  • account_idinteger · min: 1

Schedule a campaignRequest Body

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

Schedule a campaignResponses

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

Unschedule a campaign

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

Unschedule a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Unschedule a campaignquery Parameters

  • account_idinteger · min: 1

Unschedule a campaignResponses

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

Reschedule a campaign

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

Reschedule a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Reschedule a campaignquery Parameters

  • account_idinteger · min: 1

Reschedule a campaignRequest Body

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

Reschedule a campaignResponses

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

Suspend a campaign

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

Suspend a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Suspend a campaignquery Parameters

  • account_idinteger · min: 1

Suspend a campaignResponses

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

Resume a campaign

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

Resume a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Resume a campaignquery Parameters

  • account_idinteger · min: 1

Resume a campaignResponses

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

Cancel a campaign

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

Cancel a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Cancel a campaignquery Parameters

  • account_idinteger · min: 1

Cancel a campaignResponses

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

Archive a campaign

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

Archive a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Archive a campaignquery Parameters

  • account_idinteger · min: 1

Archive a campaignResponses

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

Unarchive a campaign

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

Unarchive a campaignpath Parameters

  • campaign_idinteger · min: 1 · required

Unarchive a campaignquery Parameters

  • account_idinteger · min: 1

Unarchive a campaignResponses

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

Show all campaign revisions

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

Show all campaign revisionspath Parameters

  • campaign_idinteger · required

Show all campaign revisionsquery Parameters

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

Show all campaign revisionsResponses

    • paginationobject · required
    • dataobject[] · required

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

Show a campaign linkspath Parameters

  • campaign_idinteger · required

Show a campaign linksquery Parameters

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

Show a campaign linksResponses

    • paginationobject · required
    • dataobject[] · required