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 segments › path Parameters

  • list_idinteger · min: 1 · required

​Show all segments › query Parameters

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

​Show all segments › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a segment

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

​Create a segment › path Parameters

  • list_idinteger · min: 1 · required

​Create a segment › query Parameters

  • account_idinteger · min: 1

​Create a segment › Request Body

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

​Create a segment › Responses

    • 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 details › path Parameters

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

​Show a segment details › query Parameters

  • account_idinteger · min: 1

​Show a segment details › Responses

    • dataobject · required

​Delete a segment

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

​Delete a segment › path Parameters

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

​Delete a segment › query Parameters

  • account_idinteger · min: 1

​Delete a segment › Responses

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

​Update a segment

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

​Update a segment › path Parameters

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

​Update a segment › query Parameters

  • account_idinteger · min: 1

​Update a segment › Request Body

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

​Update a segment › Responses

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