Search
Guides
API Reference
Changelog
Classic API
Account
Show my account details
get
Update my account
patch
Convert my account to an Organization
post
Action
List actions
get
Create an action
post
Get an action
get
Delete an action
delete
Update an action
patch
Render an action
get
Send a test of an action
post
Show action links
get
Campaign
Show all campaigns
get
Create a campaign
post
Show a campaign details
get
Delete a campaign
delete
Update a campaign
patch
Render a campaign
get
Send a test email
post
Schedule a campaign
post
Unschedule a campaign
post
Reschedule a campaign
post
Suspend a campaign
post
Resume a campaign
post
Cancel a campaign
post
Archive a campaign
post
Unarchive a campaign
post
Show all campaign revisions
get
Show a campaign links
get
Campaign Blueprint
Show all campaign blueprints
get
Get a campaign blueprint
get
Render campaign blueprint
get
Contact
Add interest(s) to contact(s)
post
Show contacts of a list
get
Add a contact
post
Show contacts of a segment
get
Tags multiple contacts
post
Untags multiple contacts
post
Show a contact details
get
Delete a contact
delete
Update a contact
patch
Import contacts
post
Unsubscribe a contact from a list
post
Tags a contact
post
Untags a contact
post
Remove interest(s) from contact(s)
post
Show all Contacts Exports
get
Create a Contacts Export
post
Show a Contacts Export
get
Delete a Contacts Export
delete
Download a Contacts Export
get
Custom Attribute
Show all custom attributes
get
Create a custom attribute
post
Show a custom attribute
get
Delete a custom attribute
delete
DKIM
List Dkim Keys
get
Create Dkim Key
post
Get Dkim Key
get
Delete Dkim Key
delete
Domain
Show domains
get
Change domains
patch
Validate domains
get
Transactional Email
Send an email
post
Show email stats
get
Show email activity logs
get
List Email Group Ids
get
Edit an Email Group Id
patch
List Transactional Email Templates
get
Create a Transactional Email Template
post
Show a Transactional Email Template
get
Delete a Transactional Email Template
delete
Update a Transactional Email Template
patch
Send a Transactional Email from a Template to a contact
post
Send a Test Transactional Email from a Template
post
Render a Transactional Email Template
post
Email API
Submit an email
post
Retrieve a submitted email
get
Render a submitted email
get
List Email Tags
get
Show Email API activity logs
get
Show Email API activity summary
get
Show Email API statistics
get
Form
Show all forms
get
Create a form
post
Show a form details
get
Delete a form
delete
Update a form
patch
Links
Show a link information
get
List
Show all lists
get
Create a List
post
Show a list parameters
get
Delete a List
delete
Update a list parameters
patch
Accept policy for a list
post
Archive a list
post
Enable a subscription form endpoint
post
Disable a subscription form endpoint
post
List subscription form endpoints
get
Create a subscription form endpoint
post
Show a subscription form endpoint
get
Delete a subscription form endpoint
delete
Patch a subscription form endpoint
patch
Log
Show list logs
get
Show campaign logs
get
Show action logs
get
Show all campaign log exports
get
Create a campaign log export
post
Download a campaign log export
get
Show all list logs exports
get
Create a list log export
post
Download a list logs export
get
Logo
Upload a default logo
put
Delete the default logo
delete
Segment
Show all segments
get
Create a segment
post
Show a segment details
get
Delete a segment
delete
Update a segment
patch
Sender
Show all senders
get
Add a sender
post
Show a sender details
get
Delete a sender
delete
Update a sender
patch
Confirm a sender
post
Resend confirmation email
post
Interest
Show all Interests
get
Create an Interest
post
Get an Interest
get
Delete an Interest
delete
Update an Interest
patch
Task
Show all asynchronous Tasks
get
Show an asynchronous Task
get
Delete an asynchronous Task
delete
Template
Show all templates
get
Create a template
post
Get a template
get
Delete a template
delete
Update a template
patch
Render a template
get
Report
Show list report
get
Show campaign report
get
Show campaign links report
get
Show my account report
get
Show account report
get
Show action report
get
List campaigns reports exports
get
Create a campaigns reports export
post
Get a campaigns reports export
get
Delete a campaigns report export
delete
Download a campaigns reports export
get
Suppressed Email
Show all suppressed emails
get
Add a suppressed email
post
Delete a suppressed email
delete
Show all Suppressed Emails Export
get
Create a Suppressed Emails Export
post
Show a Suppressed Emails Export
get
Delete a Suppressed Emails Export
delete
Download a suppressed emails export
get
Token
Refresh a token
put
Create or Refresh a token
post
Complete a Multi-Factor Authentication challenge
post
User
Show my user details
get
Forgot my password
post
Reset my password
post
Reset a user password
post
Reset password confirmation
post
Show all users in my account
get
Create a user
post
Show a user details
get
Delete a user
delete
Update a user
patch
Suspend a user
post
Unsuspend a user
post
Confirm a user
post
Resend the user verification email
post
List active MFA methods
get
Attach an MFA method
post
Activate an MFA method
post
Get MFA recovery codes
get
Get the MFA portal URL
get
Remove an MFA method
delete
Sub-Account
Show all sub-accounts
get
Create a sub-account
post
Show sub-account details
get
Delete a sub-account
delete
Update a sub-account
patch
Suspend a sub-account
post
Unsuspend a sub-account
post
Confirm sub-account creation
post
Resend the account verification email
post
Convert an account to an Organization
post
Workflow
Show all workflows
get
Create a workflow
post
Show a workflow
get
Delete a workflow
delete
Update a workflow
patch
Activate a workflow
post
Deactivate a workflow
post
Lock a workflow
post
Unlock a workflow
post
Workflow Blueprint
Show all workflow blueprints
get
Show a workflow blueprint
get
Show workflow blueprint actions
get
Show a workflow blueprint action
get
System Email
Show system emails configuration
get
Set system emails configuration
put
Update system emails configuration
patch
Webhook
List all webhooks
get
Create a webhook
post
Archive a webhook
post
Unarchive a webhook
post
Show a webhook
get
Patch a webhook
patch
Tags
Show a Contact Tag
get
Delete a Contact Tag
delete
Edit a Contact Tag
patch
List Contact Tags
get
Create a Contact Tag
post
Schemas
powered by Zudoku
Menu
Cakemail API
Account
(1.18.25)
Endpoint:
https://api.cakemail.dev
API information
Show my account details
GET
https://api.cakemail.dev
/accounts/self
Show my account details ›
Responses
200
400
data
object
·
required
Show properties
Update my account
PATCH
https://api.cakemail.dev
/accounts/self
Update my account ›
Request Body
address
object
Show properties
name
string
account_owner
object
Show properties
fax
string
phone
string
domains
object
Default:
{}
Show properties
website
string
·
uri
·
minLength: 1
·
maxLength: 2083
Update my account ›
Responses
200
400
422
data
object
·
required
Show properties
warnings
object[]
Default:
[]
Show properties
Convert my account to an Organization
POST
https://api.cakemail.dev
/accounts/self/convert-to-organization
Convert my account to an Organization ›
Responses
200
400
data
object
·
required
Show properties
Action
