Cakemail Logo
Cakemail API

Segment (1.18.25)

Endpoint:https://api.cakemail.dev

Show all segments

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

Show all segmentspath Parameters

  • list_idinteger · min: 1 · required

Show all segmentsquery Parameters

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

Show all segmentsResponses

    • paginationobject · required
    • dataobject[] · required

Create a segment

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

Create a segmentpath Parameters

  • list_idinteger · min: 1 · required

Create a segmentquery Parameters

  • account_idinteger · min: 1

Create a segmentRequest Body

  • namestring · minLength: 1 · required
  • querystring · minLength: 1
  • fiqlstring · minLength: 1
  • jsonobject

Create a segmentResponses

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

Show a segment details

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

Show a segment detailspath Parameters

  • list_idinteger · min: 1 · required
  • segment_idinteger · min: 1 · required

Show a segment detailsquery Parameters

  • account_idinteger · min: 1

Show a segment detailsResponses

    • dataobject · required

Delete a segment

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

Delete a segmentpath Parameters

  • list_idinteger · min: 1 · required
  • segment_idinteger · min: 1 · required

Delete a segmentquery Parameters

  • account_idinteger · min: 1

Delete a segmentResponses

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

Update a segment

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

Update a segmentpath Parameters

  • list_idinteger · min: 1 · required
  • segment_idinteger · min: 1 · required

Update a segmentquery Parameters

  • account_idinteger · min: 1

Update a segmentRequest Body

  • querystring · minLength: 1
  • fiqlstring · minLength: 1
  • jsonobject
  • namestring

Update a segmentResponses

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