Cakemail API

Workflow

Endpointhttps://api.cakemail.dev

deprecated

Show all workflows

GET

https://api.cakemail.dev

/workflows

Required scope(s): automations:read

Show all workflows › 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
description
goal
status
created_on
updated_on
activated_on

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

Valid terms:

name
description
goal
status
created_on
updated_on
activated_on

Show all workflows › Responses

Successful Response

object · required

object[] · required

GET/workflows

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

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "goal": "goal",
      "status": "active",
      "trigger": "subscribed",
      "audience": {
        "list_id": 0,
        "segment_id": 0
      },
      "created_on": 0,
      "updated_on": 0,
      "activated_on": 0
    }
  ]
}

json

application/json

deprecated

Create a workflow

POST

https://api.cakemail.dev

/workflows

Required scope(s): automations:write

Create a workflow › 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 a workflow › Request Body

object · required

name

string

goal

string

description

string

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

object

Create a workflow › Responses

Successful Response

object · required

id

string · required

object

string

Default: workflow

created

boolean

Default: true

POST/workflows

curl --request POST \
  --url https://api.cakemail.dev/workflows \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  },
  "id": "id",
  "object": "object",
  "created": true
}

json

application/json

deprecated

Show a workflow

GET

https://api.cakemail.dev

/workflows/{workflow_id}

Required scope(s): automations:read

Show a workflow › path Parameters

workflow_id

string · required

Show a workflow › 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.

Show a workflow › Responses

Successful Response

object · required

GET/workflows/{workflow_id}

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

shell

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  }
}

json

application/json

deprecated

Delete a workflow

DELETE

https://api.cakemail.dev

/workflows/{workflow_id}

Required scope(s): automations:delete

Delete a workflow › path Parameters

workflow_id

string · required

Delete a workflow › 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 a workflow › Responses

Successful Response

object · required

id

string · required

object

string

Default: workflow

deleted

boolean

Default: true

DELETE/workflows/{workflow_id}

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

shell

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  },
  "id": "id",
  "object": "object",
  "deleted": true
}

json

application/json

deprecated

Update a workflow

PATCH

https://api.cakemail.dev

/workflows/{workflow_id}

Required scope(s): automations:write

Update a workflow › path Parameters

workflow_id

string · required

Update a workflow › 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 a workflow › Request Body

name

string

goal

string

description

string

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

object

Update a workflow › Responses

Successful Response

object · required

id

string · required

object

string

Default: workflow

patched

boolean

Default: true

PATCH/workflows/{workflow_id}

curl --request PATCH \
  --url https://api.cakemail.dev/workflows/:workflow_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  },
  "id": "id",
  "object": "object",
  "patched": true
}

json

application/json

deprecated

Activate a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/activate

Required scope(s): automations:write

Activate a workflow › path Parameters

workflow_id

string · required

Activate a workflow › 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.

sender_email

string

Activate a workflow › Responses

Successful Response

id

string · required

object

string

Default: workflow

activated

boolean

Default: true

POST/workflows/{workflow_id}/activate

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/activate

shell

Example Responses

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

json

application/json

deprecated

Deactivate a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/deactivate

Required scope(s): automations:write

Deactivate a workflow › path Parameters

workflow_id

string · required

Deactivate a workflow › 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.

Deactivate a workflow › Responses

Successful Response

id

string · required

object

string

Default: workflow

deactivated

boolean

Default: true

POST/workflows/{workflow_id}/deactivate

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/deactivate

shell

Example Responses

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

json

application/json

deprecated

Lock a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/lock

Required scope(s): automations:write

Lock a workflow › path Parameters

workflow_id

string · required

Lock a workflow › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Lock a workflow › Request Body

key

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

Lock a workflow › Responses

Successful Response

locked

boolean · required

expires_in

integer · required

object

string

Default: workflow

POST/workflows/{workflow_id}/lock

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/lock \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "key"
}'

shell

Example Request Body

{
  "key": "key"
}

json

Example Responses

{
  "object": "object",
  "locked": true,
  "expires_in": 0
}

json

application/json

deprecated

Unlock a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/unlock

Required scope(s): automations:write

Unlock a workflow › path Parameters

workflow_id

string · required

Unlock a workflow › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Unlock a workflow › Request Body

key

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

Unlock a workflow › Responses

Successful Response

locked

boolean · required

expires_in

integer · required

object

string

Default: workflow

POST/workflows/{workflow_id}/unlock

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/unlock \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "key"
}'

shell

Example Request Body

{
  "key": "key"
}

json

Example Responses

{
  "object": "object",
  "locked": true,
  "expires_in": 0
}

json

application/json

Action Workflow Blueprint

Cakemail API

Workflow

Endpointhttps://api.cakemail.dev

deprecated

Show all workflows

GET

https://api.cakemail.dev

/workflows

Required scope(s): automations:read

Show all workflows › 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
description
goal
status
created_on
updated_on
activated_on

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

Valid terms:

name
description
goal
status
created_on
updated_on
activated_on

Show all workflows › Responses

Successful Response

object · required

object[] · required

GET/workflows

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

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "goal": "goal",
      "status": "active",
      "trigger": "subscribed",
      "audience": {
        "list_id": 0,
        "segment_id": 0
      },
      "created_on": 0,
      "updated_on": 0,
      "activated_on": 0
    }
  ]
}

json

application/json

deprecated

Create a workflow

POST

https://api.cakemail.dev

/workflows

Required scope(s): automations:write

Create a workflow › 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 a workflow › Request Body

object · required

name

string

goal

string

description

string

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

object

Create a workflow › Responses

Successful Response

object · required

id

string · required

object

string

Default: workflow

created

boolean

Default: true

POST/workflows

curl --request POST \
  --url https://api.cakemail.dev/workflows \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  },
  "id": "id",
  "object": "object",
  "created": true
}

json

application/json

deprecated

Show a workflow

GET

https://api.cakemail.dev

/workflows/{workflow_id}

Required scope(s): automations:read

Show a workflow › path Parameters

workflow_id

string · required

Show a workflow › 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.

Show a workflow › Responses

Successful Response

object · required

GET/workflows/{workflow_id}

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

shell

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  }
}

json

application/json

deprecated

Delete a workflow

DELETE

https://api.cakemail.dev

/workflows/{workflow_id}

Required scope(s): automations:delete

Delete a workflow › path Parameters

workflow_id

string · required

Delete a workflow › 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 a workflow › Responses

Successful Response

object · required

id

string · required

object

string

Default: workflow

deleted

boolean

Default: true

DELETE/workflows/{workflow_id}

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

shell

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  },
  "id": "id",
  "object": "object",
  "deleted": true
}

json

application/json

deprecated

Update a workflow

PATCH

https://api.cakemail.dev

/workflows/{workflow_id}

Required scope(s): automations:write

Update a workflow › path Parameters

workflow_id

string · required

Update a workflow › 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 a workflow › Request Body

name

string

goal

string

description

string

trigger

string · enum

An enumeration.

Enum values:

subscribed

unsubscribed

manual

object

Update a workflow › Responses

Successful Response

object · required

id

string · required

object

string

Default: workflow

patched

boolean

Default: true

PATCH/workflows/{workflow_id}

curl --request PATCH \
  --url https://api.cakemail.dev/workflows/:workflow_id \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}
'

shell

Example Request Body

{
  "name": "name",
  "goal": "goal",
  "description": "description",
  "trigger": "subscribed",
  "audience": {
    "list_id": 0,
    "segment_id": 0
  },
  "blueprint": {
    "id": "id",
    "email_settings": {
      "sender": {
        "id": "id"
      }
    }
  }
}

json

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "status": "active",
    "trigger": "subscribed",
    "audience": {
      "list_id": 0,
      "segment_id": 0
    },
    "created_on": 0,
    "updated_on": 0,
    "activated_on": 0
  },
  "id": "id",
  "object": "object",
  "patched": true
}

json

application/json

deprecated

Activate a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/activate

Required scope(s): automations:write

Activate a workflow › path Parameters

workflow_id

string · required

Activate a workflow › 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.

sender_email

string

Activate a workflow › Responses

Successful Response

id

string · required

object

string

Default: workflow

activated

boolean

Default: true

POST/workflows/{workflow_id}/activate

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/activate

shell

Example Responses

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

json

application/json

deprecated

Deactivate a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/deactivate

Required scope(s): automations:write

Deactivate a workflow › path Parameters

workflow_id

string · required

Deactivate a workflow › 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.

Deactivate a workflow › Responses

Successful Response

id

string · required

object

string

Default: workflow

deactivated

boolean

Default: true

POST/workflows/{workflow_id}/deactivate

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/deactivate

shell

Example Responses

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

json

application/json

deprecated

Lock a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/lock

Required scope(s): automations:write

Lock a workflow › path Parameters

workflow_id

string · required

Lock a workflow › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Lock a workflow › Request Body

key

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

Lock a workflow › Responses

Successful Response

locked

boolean · required

expires_in

integer · required

object

string

Default: workflow

POST/workflows/{workflow_id}/lock

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/lock \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "key"
}'

shell

Example Request Body

{
  "key": "key"
}

json

Example Responses

{
  "object": "object",
  "locked": true,
  "expires_in": 0
}

json

application/json

deprecated

Unlock a workflow

POST

https://api.cakemail.dev

/workflows/{workflow_id}/unlock

Required scope(s): automations:write

Unlock a workflow › path Parameters

workflow_id

string · required

Unlock a workflow › query Parameters

account_id

integer · min: 1

Optional Account ID to be used for the request

Unlock a workflow › Request Body

key

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

Unlock a workflow › Responses

Successful Response

locked

boolean · required

expires_in

integer · required

object

string

Default: workflow

POST/workflows/{workflow_id}/unlock

curl --request POST \
  --url https://api.cakemail.dev/workflows/:workflow_id/unlock \
  --header 'Content-Type: application/json' \
  --data '{
  "key": "key"
}'

shell

Example Request Body

{
  "key": "key"
}

json

Example Responses

{
  "object": "object",
  "locked": true,
  "expires_in": 0
}

json

application/json

Action Workflow Blueprint