Cakemail Logo
Cakemail API

​Action (1.18.25)

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

​List actions

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

​List actions › path Parameters

  • workflow_idstring · required

​List actions › query Parameters

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

​List actions › Responses

    • paginationobject · required
    • dataobject[] · required
deprecated

​Create an action

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

​Create an action › path Parameters

  • workflow_idstring · required

​Create an action › query Parameters

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

​Create an action › Request Body

  • namestring · required
  • conditionstring · enum · required
    Enum values:
    opened
    not_opened
    clicked
    not_clicked
    none
  • delayinteger · required
  • typestring · enum · required
    Enum values:
    email
  • parent_idstring
  • email_settingsobject

​Create an action › Responses

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

​Get an action

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

​Get an action › path Parameters

  • workflow_idstring · required
  • action_idstring · required

​Get an action › query Parameters

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

​Get an action › Responses

    • dataobject · required
deprecated

​Delete an action

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

​Delete an action › path Parameters

  • action_idstring · required
  • workflow_idstring · required

​Delete an action › query Parameters

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

​Delete an action › Responses

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

​Update an action

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

​Update an action › path Parameters

  • action_idstring · required
  • workflow_idstring · required

​Update an action › query Parameters

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

​Update an action › Request Body

  • namestring
  • parent_idstring
  • conditionstring · enum
    Enum values:
    opened
    not_opened
    clicked
    not_clicked
    none
  • delayinteger
  • typestring · enum
    Enum values:
    email
  • email_settingsobject

​Update an action › Responses

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

​Render an action

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

​Render an action › path Parameters

  • workflow_idstring · required
  • action_idstring · required

​Render an action › query Parameters

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

​Render an action › Responses

    string
deprecated

​Send a test of an action

POST
https://api.cakemail.dev
/workflows/{workflow_id}/actions/{action_id}/send-test

​Send a test of an action › path Parameters

  • workflow_idstring · required
  • action_idstring · required

​Send a test of an action › query Parameters

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

​Send a test of an action › Request Body

  • emailstring · email · required
  • typestring · enum
    Enum values:
    merged
    separated
    Default: merged

​Send a test of an action › Responses

    • idstring · required
    • objectstring
      Default: action
    • sentboolean
      Default: true
deprecated

​Show action links

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

​Show action links › path Parameters

  • action_idstring · required
  • workflow_idstring · required

​Show action links › query Parameters

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

​Show action links › Responses

    • paginationobject · required
    • dataobject[] · required
AccountCampaign