Cakemail Logo
Cakemail API

​Workflow (1.18.25)

Endpoint:https://api.cakemail.dev
deprecated

​Show all workflows

GET
https://api.cakemail.dev
/workflows

​Show all workflows › query Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • sortstring

​Show all workflows › Responses

    • paginationobject · required
    • dataobject[] · required
deprecated

​Create a workflow

POST
https://api.cakemail.dev
/workflows

​Create a workflow › query Parameters

  • account_idinteger · min: 1
  • lock_keystring · pattern: ^[a-zA-Z0-9-_]{8,}$

​Create a workflow › Request Body

  • audienceobject · required
  • namestring
  • goalstring
  • descriptionstring
  • triggerstring · enum
    Enum values:
    subscribed
    unsubscribed
    manual
    Default: subscribed
  • blueprintobject

​Create a workflow › Responses

    • dataobject · required
    • idstring · required
    • objectstring
      Default: workflow
    • createdboolean
      Default: true
deprecated

​Show a workflow

GET
https://api.cakemail.dev
/workflows/{workflow_id}

​Show a workflow › path Parameters

  • workflow_idstring · required

​Show a workflow › query Parameters

  • account_idinteger · min: 1
  • lock_keystring · pattern: ^[a-zA-Z0-9-_]{8,}$

​Show a workflow › Responses

    • dataobject · required
deprecated

​Delete a workflow

DELETE
https://api.cakemail.dev
/workflows/{workflow_id}

​Delete a workflow › path Parameters

  • workflow_idstring · required

​Delete a workflow › query Parameters

  • account_idinteger · min: 1
  • lock_keystring · pattern: ^[a-zA-Z0-9-_]{8,}$

​Delete a workflow › Responses

    • dataobject · required
    • idstring · required
    • objectstring
      Default: workflow
    • deletedboolean
      Default: true
deprecated

​Update a workflow

PATCH
https://api.cakemail.dev
/workflows/{workflow_id}

​Update a workflow › path Parameters

  • workflow_idstring · required

​Update a workflow › query Parameters

  • account_idinteger · min: 1
  • lock_keystring · pattern: ^[a-zA-Z0-9-_]{8,}$

​Update a workflow › Request Body

  • namestring
  • goalstring
  • descriptionstring
  • triggerstring · enum
    Enum values:
    subscribed
    unsubscribed
    manual
  • audienceobject
  • blueprintobject

​Update a workflow › Responses

    • dataobject · required
    • idstring · required
    • objectstring
      Default: workflow
    • patchedboolean
      Default: true
deprecated

​Activate a workflow

POST
https://api.cakemail.dev
/workflows/{workflow_id}/activate

​Activate a workflow › path Parameters

  • workflow_idstring · required

​Activate a workflow › query Parameters

  • account_idinteger · min: 1
  • lock_keystring · pattern: ^[a-zA-Z0-9-_]{8,}$
  • sender_emailstring

​Activate a workflow › Responses

    • idstring · required
    • objectstring
      Default: workflow
    • activatedboolean
      Default: true
deprecated

​Deactivate a workflow

POST
https://api.cakemail.dev
/workflows/{workflow_id}/deactivate

​Deactivate a workflow › path Parameters

  • workflow_idstring · required

​Deactivate a workflow › query Parameters

  • account_idinteger · min: 1
  • lock_keystring · pattern: ^[a-zA-Z0-9-_]{8,}$

​Deactivate a workflow › Responses

    • idstring · required
    • objectstring
      Default: workflow
    • deactivatedboolean
      Default: true
deprecated

​Lock a workflow

POST
https://api.cakemail.dev
/workflows/{workflow_id}/lock

​Lock a workflow › path Parameters

  • workflow_idstring · required

​Lock a workflow › query Parameters

  • account_idinteger · min: 1

​Lock a workflow › Request Body

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

​Lock a workflow › Responses

    • lockedboolean · required
    • expires_ininteger · required
    • objectstring
      Default: workflow
deprecated

​Unlock a workflow

POST
https://api.cakemail.dev
/workflows/{workflow_id}/unlock

​Unlock a workflow › path Parameters

  • workflow_idstring · required

​Unlock a workflow › query Parameters

  • account_idinteger · min: 1

​Unlock a workflow › Request Body

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

​Unlock a workflow › Responses

    • lockedboolean · required
    • expires_ininteger · required
    • objectstring
      Default: workflow
Sub-AccountWorkflow Blueprint