Cakemail
Cakemail API
Cakemail API

Workflow

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

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

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

ListWorkflowsResponse
​Pagination · required
​WorkflowResponse[] · required
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

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.

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

Create a workflow › Request Body

Workflow
​WorkflowAudience · required
name
​string
goal
​string
description
​string
trigger
​string · enum

An enumeration.

Enum values:
subscribed
unsubscribed
manual
Default: subscribed

Create a workflow › Responses

Successful Response

CreateWorkflowResponse
​WorkflowResponse · required
id
​string · required
object
​string
Default: workflow
created
​boolean
Default: true
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

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.

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

Show a workflow › Responses

Successful Response

GetWorkflowResponse
​WorkflowResponse · required
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

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.

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

Update a workflow › Request Body

PatchWorkflow
name
​string
goal
​string
description
​string
trigger
​WorkflowTrigger · enum

An enumeration.

Enum values:
subscribed
unsubscribed
manual
​WorkflowAudience

Update a workflow › Responses

Successful Response

PatchWorkflowResponse
​WorkflowResponse · required
id
​string · required
object
​string
Default: workflow
patched
​boolean
Default: true
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

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.

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

Delete a workflow › Responses

Successful Response

DeleteWorkflowResponse
​WorkflowResponse · required
id
​string · required
object
​string
Default: workflow
deleted
​boolean
Default: true
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

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.

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

sender_email
​string

Activate a workflow › Responses

Successful Response

ActivateWorkflowResponse
id
​string · required
object
​string
Default: workflow
activated
​boolean
Default: true
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

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.

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

Deactivate a workflow › Responses

Successful Response

DeactivateWorkflowResponse
id
​string · required
object
​string
Default: workflow
deactivated
​boolean
Default: true
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

Optional Account ID to be used for the request

Lock a workflow › Request Body

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

Lock a workflow › Responses

Successful Response

LockWorkflowResponse
locked
​boolean · required
expires_in
​integer · required
object
​string
Default: workflow
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

Optional Account ID to be used for the request

Unlock a workflow › Request Body

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

Unlock a workflow › Responses

Successful Response

UnlockWorkflowResponse
locked
​boolean · required
expires_in
​integer · required
object
​string
Default: workflow
ActionWorkflow Blueprint