Cakemail Logo
Cakemail API

List (1.18.25)

Endpoint:https://api.cakemail.dev

Show all lists

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

Show all listsquery Parameters

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

Show all listsResponses

    • paginationobject · required
    • dataobject[] · required

Create a List

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

Create a Listquery Parameters

  • account_idinteger · min: 1

Create a ListRequest Body

  • namestring · minLength: 1 · required
  • default_senderobject · required
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
    Default: en_US
  • redirectionsobject
    Default: {}
  • webhookobject
    Default: {}

Create a ListResponses

    • idinteger · required
    • dataobject · required
    • createdboolean
      Default: true

Show a list parameters

GET
https://api.cakemail.dev
/lists/{list_id}

Show a list parameterspath Parameters

  • list_idinteger · min: 1 · required

Show a list parametersquery Parameters

  • account_idinteger · min: 1

Show a list parametersResponses

    • dataobject · required

Delete a List

DELETE
https://api.cakemail.dev
/lists/{list_id}

Delete a Listpath Parameters

  • list_idinteger · min: 1 · required

Delete a Listquery Parameters

  • account_idinteger · min: 1

Delete a ListResponses

    • idinteger · required
    • objectstring
      Default: list
    • deletedboolean
      Default: true

Update a list parameters

PATCH
https://api.cakemail.dev
/lists/{list_id}

Update a list parameterspath Parameters

  • list_idinteger · min: 1 · required

Update a list parametersquery Parameters

  • account_idinteger · min: 1

Update a list parametersRequest Body

  • namestring · minLength: 1
  • default_senderobject
  • languagestring · enum
    Enum values:
    da
    da_DK
    de
    de_DE
    el
    el_GR
    en
    en_US
  • redirectionsobject
    Default: {}
  • webhookobject
    Default: {}

Update a list parametersResponses

    • idinteger · required
    • dataobject · required
    • updatedboolean
      Default: true

Accept policy for a list

POST
https://api.cakemail.dev
/lists/{list_id}/accept-policy

Accept policy for a listpath Parameters

  • list_idinteger · min: 1 · required

Accept policy for a listquery Parameters

  • account_idinteger · min: 1

Accept policy for a listResponses

    • idinteger · required
    • objectstring
      Default: list
    • policy_acceptedboolean
      Default: true

Archive a list

POST
https://api.cakemail.dev
/lists/{list_id}/archive

Archive a listpath Parameters

  • list_idinteger · min: 1 · required

Archive a listquery Parameters

  • account_idinteger · min: 1

Archive a listResponses

    • idinteger · required
    • objectstring
      Default: list
    • archivedboolean
      Default: true

Enable a subscription form endpoint

POST
https://api.cakemail.dev
/lists/{list_id}/forms/{form_id}/enable

Enable a subscription form endpointpath Parameters

  • form_idstring · minLength: 1 · pattern: ^[a-zA-Z0-9]+$ · required
  • list_idinteger · min: 1 · required

Enable a subscription form endpointquery Parameters

  • account_idinteger · min: 1

Enable a subscription form endpointResponses

    • dataobject · required
    • objectstring
      Default: subscription_form_endpoint
    • enabledboolean
      Default: true

Disable a subscription form endpoint

POST
https://api.cakemail.dev
/lists/{list_id}/forms/{form_id}/disable

Disable a subscription form endpointpath Parameters

  • form_idstring · minLength: 1 · pattern: ^[a-zA-Z0-9]+$ · required
  • list_idinteger · min: 1 · required

Disable a subscription form endpointquery Parameters

  • account_idinteger · min: 1

Disable a subscription form endpointResponses

    • dataobject · required
    • objectstring
      Default: subscription_form_endpoint
    • enabledboolean

List subscription form endpoints

GET
https://api.cakemail.dev
/lists/{list_id}/forms

List subscription form endpointspath Parameters

  • list_idinteger · min: 1 · required

List subscription form endpointsquery Parameters

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

List subscription form endpointsResponses

    • paginationobject · required
    • dataobject[] · required

Create a subscription form endpoint

POST
https://api.cakemail.dev
/lists/{list_id}/forms

Create a subscription form endpointpath Parameters

  • list_idinteger · min: 1 · required

Create a subscription form endpointquery Parameters

  • account_idinteger · min: 1

Create a subscription form endpointRequest Body

  • domainstring · pattern: ^(?:[a-zA-Z0-9](?:[a…
  • namestring
  • double_opt_inboolean
    Default: true
  • secretstring
  • post_redirect_urlstring
  • double_opt_in_redirect_urlstring
  • async_processingboolean
    Default: true

Create a subscription form endpointResponses

    • dataobject · required
    • objectstring
      Default: subscription_form_endpoint
    • createdboolean
      Default: true

Show a subscription form endpoint

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

Show a subscription form endpointpath Parameters

  • form_idstring · minLength: 1 · pattern: ^[a-zA-Z0-9]+$ · required
  • list_idinteger · min: 1 · required

Show a subscription form endpointquery Parameters

  • account_idinteger · min: 1

Show a subscription form endpointResponses

    • dataobject · required

Delete a subscription form endpoint

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

Delete a subscription form endpointpath Parameters

  • form_idstring · minLength: 1 · pattern: ^[a-zA-Z0-9]+$ · required
  • list_idinteger · min: 1 · required

Delete a subscription form endpointquery Parameters

  • account_idinteger · min: 1

Delete a subscription form endpointResponses

    • dataobject · required
    • objectstring
      Default: subscription_form_endpoint
    • deletedboolean
      Default: true

Patch a subscription form endpoint

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

Patch a subscription form endpointpath Parameters

  • form_idstring · minLength: 1 · pattern: ^[a-zA-Z0-9]+$ · required
  • list_idinteger · min: 1 · required

Patch a subscription form endpointquery Parameters

  • account_idinteger · min: 1

Patch a subscription form endpointRequest Body

  • domainstring · pattern: ^(?:[a-zA-Z0-9](?:[a…
  • namestring
  • double_opt_inboolean
  • secretstring
  • post_redirect_urlstring
  • double_opt_in_redirect_urlstring
  • async_processingboolean

Patch a subscription form endpointResponses

    • dataobject · required
    • objectstring
      Default: subscription_form_endpoint
    • updatedboolean
      Default: true