Cakemail Logo
Cakemail API

​Interest (1.18.25)

Endpoint:https://api.cakemail.dev

​Show all Interests

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

​Show all Interests › path Parameters

  • list_idinteger · required

​Show all Interests › query Parameters

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

​Show all Interests › Responses

    • paginationobject · required
    • dataobject[] · required

​Create an Interest

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

​Create an Interest › path Parameters

  • list_idinteger · required

​Create an Interest › query Parameters

  • account_idinteger · min: 1

​Create an Interest › Request Body

  • namestring · minLength: 1 · maxLength: 255 · pattern: ^[+@\-_#a-zA-Z0-9]+$ · required
  • aliasstring

​Create an Interest › Responses

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

​Get an Interest

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

​Get an Interest › path Parameters

  • list_idinteger · required
  • interest_namestring · minLength: 1 · maxLength: 255 · pattern: ^[+@\-_#a-zA-Z0-9]+$ · required

​Get an Interest › query Parameters

  • account_idinteger · min: 1

​Get an Interest › Responses

    • dataobject · required

​Delete an Interest

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

​Delete an Interest › path Parameters

  • list_idinteger · required
  • interest_namestring · minLength: 1 · maxLength: 255 · pattern: ^[+@\-_#a-zA-Z0-9]+$ · required

​Delete an Interest › query Parameters

  • account_idinteger · min: 1

​Delete an Interest › Responses

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

​Update an Interest

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

​Update an Interest › path Parameters

  • list_idinteger · required
  • interest_namestring · minLength: 1 · maxLength: 255 · pattern: ^[+@\-_#a-zA-Z0-9]+$ · required

​Update an Interest › query Parameters

  • account_idinteger · min: 1

​Update an Interest › Request Body

  • namestring
  • aliasstring

​Update an Interest › Responses

    • dataobject · required
    • objectstring
      Default: interest
    • patchedboolean
      Default: true
SenderTask