Cakemail API

Workflow Blueprint

Endpointhttps://api.cakemail.dev

deprecated

Show all workflow blueprints

GET

https://api.cakemail.dev

/workflow-blueprints

Required scope(s): automations:read

Show all workflow blueprints › query Parameters

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
created_on
updated_on

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

Valid terms:

name
description
goal
created_on
updated_on

Show all workflow blueprints › Responses

Successful Response

object · required

object[] · required

GET/workflow-blueprints

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

shell

Example Responses

{
  "pagination": {
    "page": 0,
    "per_page": 0,
    "count": 0
  },
  "data": [
    {
      "id": "id",
      "name": "name",
      "description": "description",
      "goal": "goal",
      "trigger": "subscribed",
      "created_on": 0,
      "updated_on": 0
    }
  ]
}

json

application/json

deprecated

Show a workflow blueprint

GET

https://api.cakemail.dev

/workflow-blueprints/{blueprint_id}

Required scope(s): automations:read

Show a workflow blueprint › path Parameters

blueprint_id

string · required

Show a workflow blueprint › Responses

Successful Response

object · required

GET/workflow-blueprints/{blueprint_id}

curl --request GET \
  --url https://api.cakemail.dev/workflow-blueprints/:blueprint_id

shell

Example Responses

{
  "data": {
    "id": "id",
    "name": "name",
    "description": "description",
    "goal": "goal",
    "trigger": "subscribed",
    "created_on": 0,
    "updated_on": 0
  }
}

json

application/json

deprecated

Show workflow blueprint actions

GET

https://api.cakemail.dev

/workflow-blueprints/{blueprint_id}/actions

Required scope(s): automations:read

Show workflow blueprint actions › path Parameters

blueprint_id

string · required

Show workflow blueprint actions › query Parameters

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

Show workflow blueprint actions › Responses

Successful Response

object · required

object[] · required

GET/workflow-blueprints/{blueprint_id}/actions

curl --request GET \
  --url https://api.cakemail.dev/workflow-blueprints/:blueprint_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

Show a workflow blueprint action

GET

https://api.cakemail.dev

/workflow-blueprints/{blueprint_id}/actions/{action_id}

Required scope(s): automations:read

Show a workflow blueprint action › path Parameters

blueprint_id

string · required

action_id

string · required

Show a workflow blueprint action › Responses

Successful Response

object · required

GET/workflow-blueprints/{blueprint_id}/actions/{action_id}

curl --request GET \
  --url https://api.cakemail.dev/workflow-blueprints/:blueprint_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
        }
      }
    }
  }
}

json

application/json

Workflow

Show all workflow blueprints

GET

https://api.cakemail.dev

/workflow-blueprints

Required scope(s): automations:read

Show all workflow blueprints › query Parameters

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
created_on
updated_on

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

Valid terms:

name
description
goal
created_on
updated_on

Show all workflow blueprints › Responses

Successful Response

object · required

object[] · required

Show workflow blueprint actions

GET

https://api.cakemail.dev

/workflow-blueprints/{blueprint_id}/actions

Required scope(s): automations:read

Show workflow blueprint actions › path Parameters

blueprint_id

string · required

Show workflow blueprint actions › query Parameters

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

Show workflow blueprint actions › Responses

Successful Response

object · required

object[] · required

Show a workflow blueprint action

GET

https://api.cakemail.dev

/workflow-blueprints/{blueprint_id}/actions/{action_id}

Required scope(s): automations:read

Show a workflow blueprint action › path Parameters

blueprint_id

string · required

action_id

string · required

Show a workflow blueprint action › Responses

Successful Response

object · required

{ "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 } } } } }