Cakemail API

Action

Endpointhttps://api.cakemail.dev

deprecated

List actions

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions

Required scope(s): automations:read

List actions › path Parameters

workflow_id

string · required

List actions › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
created_on

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
created_on

List actions › Responses

Successful Response

object · required

object[] · required

GET/workflows/{workflow_id}/actions

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "name": "name",
      "parent_id": "parent_id",
      "condition": "opened",
      "delay": 0,
      "type": "email",
      "created_on": 0,
      "updated_on": 0,
      "thumbnail_url": "thumbnail_url"
    }
  ]
}

json

application/json

deprecated

Create an action

POST

https://api.cakemail.dev

/workflows/{workflow_id}/actions

Required scope(s): automations:write

Create an action › path Parameters

workflow_id

string · required

Create an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Create an action › Request Body

name

string · required

condition

string · enum · required

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer · required

type

string · enum · required

An enumeration.

Enum values:

parent_id

string

object

Create an action › Responses

Successful Response

id

string · required

object · required

object

string

Default: action

created

boolean

Default: true

POST/workflows/{workflow_id}/actions

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8",
      "template": {
        "id": 0
      }
    },
    "sender": {
      "id": "id"
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8",
      "template": {
        "id": 0
      }
    },
    "sender": {
      "id": "id"
    }
  }
}

json

Example Responses

{
  "id": "id",
  "object": "object",
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  },
  "created": true
}

json

application/json

deprecated

Get an action

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}

Required scope(s): automations:read

Get an action › path Parameters

workflow_id

string · required

action_id

string · required

Get an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Get an action › Responses

Successful Response

object · required

GET/workflows/{workflow_id}/actions/{action_id}

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Delete an action

DELETE

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}

Required scope(s): automations:delete

Delete an action › path Parameters

action_id

string · required

workflow_id

string · required

Delete an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Delete an action › Responses

Successful Response

id

string · required

object · required

object

string

Default: action

deleted

boolean

Default: true

DELETE/workflows/{workflow_id}/actions/{action_id}

curl --request DELETE \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id

shell

Example Responses

{
  "id": "id",
  "object": "object",
  "deleted": true,
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Update an action

PATCH

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}

Required scope(s): automations:write

Update an action › path Parameters

action_id

string · required

workflow_id

string · required

Update an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Update an action › Request Body

name

string

parent_id

string

condition

string · enum

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer

type

string · enum

An enumeration.

Enum values:

object

Update an action › Responses

Successful Response

id

string · required

object · required

object

string

Default: action

patched

boolean

Default: true

PATCH/workflows/{workflow_id}/actions/{action_id}

curl --request PATCH \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8"
    },
    "sender": {
      "id": "id"
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8"
    },
    "sender": {
      "id": "id"
    }
  }
}

json

Example Responses

{
  "id": "id",
  "object": "object",
  "patched": true,
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Render an action

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}/render

Required scope(s): automations:read

Render an action › path Parameters

workflow_id

string · required

action_id

string · required

Render an action › query Parameters

contact_id

integer · min: 1

account_id

integer · min: 1

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Render an action › Responses

Successful Response

string

GET/workflows/{workflow_id}/actions/{action_id}/render

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id/render

shell

Example Responses

string

html

text/html

deprecated

Send a test of an action

POST

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}/send-test

Required scope(s): automations:write

Send a test of an action › path Parameters

workflow_id

string · required

action_id

string · required

Send a test of an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Send a test of an action › Request Body

email

string · email · required

type

string · enum

An enumeration.

Enum values:

merged

separated

Send a test of an action › Responses

Successful Response

id

string · required

object

string

Default: action

sent

boolean

Default: true

POST/workflows/{workflow_id}/actions/{action_id}/send-test

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id/send-test \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "test@example.com",
  "type": "merged"
}
'

shell

Example Request Body

{
  "email": "test@example.com",
  "type": "merged"
}

json

Example Responses

{
  "id": "id",
  "object": "object",
  "sent": true
}

json

application/json

deprecated

Show action links

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}/links

Show action links › path Parameters

action_id

string · required

workflow_id

string · required

Show action links › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

Show action links › Responses

Successful Response

object · required

object[] · required

List of links

GET/workflows/{workflow_id}/actions/{action_id}/links

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id/links

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "status": "status",
      "link_to": "link_to"
    }
  ]
}

json

application/json

Sub-Account Workflow

Cakemail API

Action

Endpointhttps://api.cakemail.dev

deprecated

List actions

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions

Required scope(s): automations:read

List actions › path Parameters

workflow_id

string · required

List actions › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

sort

string

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
created_on

Sort term and direction, using syntax [-|+]term.

Valid terms:

name
created_on

List actions › Responses

Successful Response

object · required

object[] · required

GET/workflows/{workflow_id}/actions

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "name": "name",
      "parent_id": "parent_id",
      "condition": "opened",
      "delay": 0,
      "type": "email",
      "created_on": 0,
      "updated_on": 0,
      "thumbnail_url": "thumbnail_url"
    }
  ]
}

json

application/json

deprecated

Create an action

POST

https://api.cakemail.dev

/workflows/{workflow_id}/actions

Required scope(s): automations:write

Create an action › path Parameters

workflow_id

string · required

Create an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Create an action › Request Body

name

string · required

condition

string · enum · required

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer · required

type

string · enum · required

An enumeration.

Enum values:

parent_id

string

object

Create an action › Responses

Successful Response

id

string · required

object · required

object

string

Default: action

created

boolean

Default: true

POST/workflows/{workflow_id}/actions

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8",
      "template": {
        "id": 0
      }
    },
    "sender": {
      "id": "id"
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8",
      "template": {
        "id": 0
      }
    },
    "sender": {
      "id": "id"
    }
  }
}

json

Example Responses

{
  "id": "id",
  "object": "object",
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  },
  "created": true
}

json

application/json

deprecated

Get an action

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}

Required scope(s): automations:read

Get an action › path Parameters

workflow_id

string · required

action_id

string · required

Get an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Get an action › Responses

Successful Response

object · required

GET/workflows/{workflow_id}/actions/{action_id}

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Delete an action

DELETE

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}

Required scope(s): automations:delete

Delete an action › path Parameters

action_id

string · required

workflow_id

string · required

Delete an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Delete an action › Responses

Successful Response

id

string · required

object · required

object

string

Default: action

deleted

boolean

Default: true

DELETE/workflows/{workflow_id}/actions/{action_id}

curl --request DELETE \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id

shell

Example Responses

{
  "id": "id",
  "object": "object",
  "deleted": true,
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Update an action

PATCH

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}

Required scope(s): automations:write

Update an action › path Parameters

action_id

string · required

workflow_id

string · required

Update an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Update an action › Request Body

name

string

parent_id

string

condition

string · enum

An enumeration.

Enum values:

opened

not_opened

clicked

not_clicked

none

delay

integer

type

string · enum

An enumeration.

Enum values:

object

Update an action › Responses

Successful Response

id

string · required

object · required

object

string

Default: action

patched

boolean

Default: true

PATCH/workflows/{workflow_id}/actions/{action_id}

curl --request PATCH \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8"
    },
    "sender": {
      "id": "id"
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "parent_id": "parent_id",
  "condition": "opened",
  "delay": 0,
  "type": "email",
  "email_settings": {
    "tracking": {
      "opens": true,
      "clicks_html": true,
      "clicks_text": true
    },
    "content": {
      "subject": "subject",
      "html": "html",
      "text": "text",
      "json": {},
      "type": "custom",
      "encoding": "utf-8"
    },
    "sender": {
      "id": "id"
    }
  }
}

json

Example Responses

{
  "id": "id",
  "object": "object",
  "patched": true,
  "data": {
    "id": "id",
    "created_on": 0,
    "updated_on": 0,
    "name": "name",
    "parent_id": "parent_id",
    "condition": "opened",
    "delay": 0,
    "type": "email",
    "email_settings": {
      "tracking": {
        "opens": true,
        "clicks_html": true,
        "clicks_text": true
      },
      "content": {
        "subject": "subject",
        "html": "html",
        "text": "text",
        "json": {},
        "type": "custom",
        "encoding": "utf-8",
        "template": {
          "id": 0
        }
      },
      "sender": {
        "id": "id"
      }
    },
    "thumbnail_url": "thumbnail_url"
  }
}

json

application/json

deprecated

Render an action

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}/render

Required scope(s): automations:read

Render an action › path Parameters

workflow_id

string · required

action_id

string · required

Render an action › query Parameters

contact_id

integer · min: 1

account_id

integer · min: 1

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Render an action › Responses

Successful Response

string

GET/workflows/{workflow_id}/actions/{action_id}/render

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id/render

shell

Example Responses

string

html

text/html

deprecated

Send a test of an action

POST

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}/send-test

Required scope(s): automations:write

Send a test of an action › path Parameters

workflow_id

string · required

action_id

string · required

Send a test of an action › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

lock_key

string · pattern: ^[a-zA-Z0-9-_]{8,}$

Locking key, preventing other users from modifying this workflow for a short period.

Send a test of an action › Request Body

email

string · email · required

type

string · enum

An enumeration.

Enum values:

merged

separated

Send a test of an action › Responses

Successful Response

id

string · required

object

string

Default: action

sent

boolean

Default: true

POST/workflows/{workflow_id}/actions/{action_id}/send-test

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id/send-test \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "test@example.com",
  "type": "merged"
}
'

shell

Example Request Body

{
  "email": "test@example.com",
  "type": "merged"
}

json

Example Responses

{
  "id": "id",
  "object": "object",
  "sent": true
}

json

application/json

deprecated

Show action links

GET

https://api.cakemail.dev

/workflows/{workflow_id}/actions/{action_id}/links

Show action links › path Parameters

action_id

string · required

workflow_id

string · required

Show action links › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

page

integer · min: 1

Default: 1

per_page

integer · min: 1

Default: 50

with_count

boolean

Include count in the response

Default: false

Show action links › Responses

Successful Response

object · required

object[] · required

List of links

GET/workflows/{workflow_id}/actions/{action_id}/links

curl --request GET \
  --url https://api.cakemail.dev/workflows/:workflow_id/actions/:action_id/links

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": 0,
      "status": "status",
      "link_to": "link_to"
    }
  ]
}

json

application/json

Sub-Account Workflow