Cakemail
Cakemail API
Cakemail API

Workflow Blueprint

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

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

WorkflowBlueprintsResponse
​Pagination · required
​WorkflowBlueprint[] · required
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

WorkflowBlueprintResponse
​WorkflowBlueprint · required
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

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

ActionsResponse
​Pagination · required
​ActionSummaryResponse[] · required
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

WorkflowBlueprintActionResponse
​ActionBlueprint · required
Workflow