Cakemail Logo
Cakemail API

Form (1.18.25)

Endpoint:https://api.cakemail.dev

Show all forms

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

Show all formsquery Parameters

  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • sortstring · pattern: [-|+]?[a-zA-Z_]+

Show all formsResponses

    • paginationobject · required
    • dataobject[] · required

Create a form

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

Create a formquery Parameters

  • account_idinteger · min: 1

Create a formRequest Body

  • namestring · minLength: 1 · required
  • contentobject · required
  • list_idinteger · min: 1 · required
  • languagestring · enum · required
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • statusstring · enum
    Enum values:
    active
    deleted
    Default: active
  • redirectionsobject
    Default: {}
  • double_opt_inboolean
    Default: true

Create a formResponses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: form
    • createdboolean
      Default: true

Show a form details

GET
https://api.cakemail.dev
/forms/{form_id}

Show a form detailspath Parameters

  • form_idstring · required

Show a form detailsquery Parameters

  • account_idinteger · min: 1

Show a form detailsResponses

    • dataobject · required

Delete a form

DELETE
https://api.cakemail.dev
/forms/{form_id}

Delete a formpath Parameters

  • form_idstring · required

Delete a formquery Parameters

  • account_idinteger · min: 1

Delete a formResponses

    • idstring · required
    • objectstring
      Default: form
    • deletedboolean
      Default: true

Update a form

PATCH
https://api.cakemail.dev
/forms/{form_id}

Update a formpath Parameters

  • form_idstring · required

Update a formquery Parameters

  • account_idinteger · min: 1

Update a formRequest Body

  • namestring · minLength: 1
  • statusstring · minLength: 1
  • contentobject
    Default: {}
  • redirectionsobject
    Default: {}
  • list_idinteger · min: 1
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • double_opt_inboolean

Update a formResponses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: form
    • updatedboolean
      Default: true