Cakemail Logo
Cakemail API

​Custom Attribute (1.18.25)

Endpoint:https://api.cakemail.dev

​Show all custom attributes

GET
https://api.cakemail.dev
/lists/{list_id}/custom-attributes

​Show all custom attributes › path Parameters

  • list_idinteger · min: 1 · required

​Show all custom attributes › query Parameters

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

​Show all custom attributes › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a custom attribute

POST
https://api.cakemail.dev
/lists/{list_id}/custom-attributes

​Create a custom attribute › path Parameters

  • list_idinteger · min: 1 · required

​Create a custom attribute › query Parameters

  • account_idinteger · min: 1

​Create a custom attribute › Request Body

  • namestring · pattern: ^[A-Za-z0-9\-_]+$ · required
  • typestring · enum · required
    Enum values:
    text
    mediumtext
    integer
    timestamp
    datetime

​Create a custom attribute › Responses

    • namestring · required
    • dataobject · required
    • objectstring
      Default: attribute
    • createdboolean
      Default: true

​Show a custom attribute

GET
https://api.cakemail.dev
/lists/{list_id}/custom-attributes/{name}

​Show a custom attribute › path Parameters

  • list_idinteger · min: 1 · required
  • namestring · required

​Show a custom attribute › query Parameters

  • account_idinteger · min: 1

​Show a custom attribute › Responses

    • dataobject · required

​Delete a custom attribute

DELETE
https://api.cakemail.dev
/lists/{list_id}/custom-attributes/{name}

​Delete a custom attribute › path Parameters

  • list_idinteger · min: 1 · required
  • namestring · pattern: ^[A-Za-z0-9\-_]+$ · required

​Delete a custom attribute › query Parameters

  • account_idinteger · min: 1

​Delete a custom attribute › Responses

    • namestring · required
    • objectstring
      Default: attribute
    • deletedboolean
      Default: true
ContactDKIM