Create a campaign
POST
https://api.cakemail.dev
/campaigns
query Parameters
account_id
integer · min: 1
Request Body
name
string · minLength: 1 · required
audience
objectDefault: {}tracking
objectDefault: {"opens":true,"clicks_html":true,"clicks_text":true}sender
objectreply_to_email
string · emailcontent
objectDefault: {"type":"html"}
Responses
id
integer · requireddata
object · requiredobject
stringDefault: campaigncreated
booleanDefault: true
Update a campaign
PATCH
https://api.cakemail.dev
/campaigns/{campaign_id}
path Parameters
campaign_id
integer · min: 1 · required
query Parameters
account_id
integer · min: 1
Request Body
name
string · minLength: 1audience
objectDefault: {}tracking
objectsender
objectreply_to_email
string · emailcontent
objectDefault: {}
Responses
id
integer · requireddata
object · requiredobject
stringDefault: campaignupdated
booleanDefault: true
Send a test email
POST
https://api.cakemail.dev
/campaigns/{campaign_id}/send-test
path Parameters
campaign_id
integer · min: 1 · required
query Parameters
account_id
integer · min: 1
Request Body
email
string · email · required
type
string · enumEnum values:mergedseparatedDefault: merged
Responses
email
string · email · requiredtype
string · enum · requiredEnum values:mergedseparatedobject
stringDefault: test_emailsent
booleanDefault: true
Schedule a campaign
POST
https://api.cakemail.dev
/campaigns/{campaign_id}/schedule
Reschedule a campaign
POST
https://api.cakemail.dev
/campaigns/{campaign_id}/reschedule
Show all campaign revisions
GET
https://api.cakemail.dev
/campaigns/{campaign_id}/revisions
Show a campaign links
GET
https://api.cakemail.dev
/campaigns/{campaign_id}/links