Show all segments
GET
https://api.cakemail.dev
/lists/{list_id}/segments
Create a segment
POST
https://api.cakemail.dev
/lists/{list_id}/segments
path Parameters
list_id
integer · min: 1 · required
query Parameters
account_id
integer · min: 1
Request Body
name
string · minLength: 1 · required
query
string · minLength: 1fiql
string · minLength: 1json
object
Responses
id
integer · requireddata
object · requiredobject
stringDefault: segmentcreated
booleanDefault: true
Delete a segment
DELETE
https://api.cakemail.dev
/lists/{list_id}/segments/{segment_id}
Update a segment
PATCH
https://api.cakemail.dev
/lists/{list_id}/segments/{segment_id}
path Parameters
list_id
integer · min: 1 · requiredsegment_id
integer · min: 1 · required
query Parameters
account_id
integer · min: 1
Request Body
query
string · minLength: 1fiql
string · minLength: 1json
objectname
string
Responses
id
integer · requireddata
object · requiredobject
stringDefault: segmentupdated
booleanDefault: true