Create a List
POST
https://api.cakemail.dev
/lists
query Parameters
account_id
integer · min: 1
Request Body
name
string · minLength: 1 · requireddefault_sender
object · required
language
string · enumEnum values:dada_DKdede_DEelel_GRenen_USDefault: en_USredirections
objectDefault: {}webhook
objectDefault: {}
Responses
id
integer · requireddata
object · requiredcreated
booleanDefault: true
Update a list parameters
PATCH
https://api.cakemail.dev
/lists/{list_id}
path Parameters
list_id
integer · min: 1 · required
query Parameters
account_id
integer · min: 1
Request Body
name
string · minLength: 1default_sender
objectlanguage
string · enumEnum values:dada_DKdede_DEelel_GRenen_USredirections
objectDefault: {}webhook
objectDefault: {}
Responses
id
integer · requireddata
object · requiredupdated
booleanDefault: true
Enable a subscription form endpoint
POST
https://api.cakemail.dev
/lists/{list_id}/forms/{form_id}/enable
Disable a subscription form endpoint
POST
https://api.cakemail.dev
/lists/{list_id}/forms/{form_id}/disable
List subscription form endpoints
GET
https://api.cakemail.dev
/lists/{list_id}/forms
Create a subscription form endpoint
POST
https://api.cakemail.dev
/lists/{list_id}/forms
path Parameters
list_id
integer · min: 1 · required
query Parameters
account_id
integer · min: 1
Request Body
domain
string · pattern:^(?:[a-zA-Z0-9](?:[a…
name
stringdouble_opt_in
booleanDefault: truesecret
stringpost_redirect_url
stringdouble_opt_in_redirect_url
stringasync_processing
booleanDefault: true
Responses
data
object · requiredobject
stringDefault: subscription_form_endpointcreated
booleanDefault: true
Delete a subscription form endpoint
DELETE
https://api.cakemail.dev
/lists/{list_id}/forms/{form_id}
Patch a subscription form endpoint
PATCH
https://api.cakemail.dev
/lists/{list_id}/forms/{form_id}
path Parameters
form_id
string · minLength: 1 · pattern:^[a-zA-Z0-9]+$
· requiredlist_id
integer · min: 1 · required
query Parameters
account_id
integer · min: 1
Request Body
domain
string · pattern:^(?:[a-zA-Z0-9](?:[a…
name
stringdouble_opt_in
booleansecret
stringpost_redirect_url
stringdouble_opt_in_redirect_url
stringasync_processing
boolean
Responses
data
object · requiredobject
stringDefault: subscription_form_endpointupdated
booleanDefault: true