Cakemail Logo
Cakemail API

​Contact (1.18.25)

Endpoint:https://api.cakemail.dev

​Add interest(s) to contact(s)

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

​Add interest(s) to contact(s) › path Parameters

  • list_idinteger · min: 1 · required

​Add interest(s) to contact(s) › query Parameters

  • account_idinteger · min: 1

​Add interest(s) to contact(s) › Request Body

  • interestsstring[] · maxItems: 16 · required
  • contact_idsinteger[] · min: 1 · maxItems: 1024
  • querystring
  • fiqlstring
  • jsonobject

​Add interest(s) to contact(s) › Responses

    • objectstring
      Default: interests
    • addedboolean
      Default: true

​Show contacts of a list

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

​Show contacts of a list › path Parameters

  • list_idinteger · min: 1 · required

​Show contacts of a list › query Parameters

  • querystring
  • jsonstring · json-string
  • cursorstring
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • sortstring
  • filterstring
  • fiqlstring

​Show contacts of a list › Responses

    • paginationobject · required
    • dataobject[] · required

​Add a contact

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

​Add a contact › path Parameters

  • list_idinteger · min: 1 · required

​Add a contact › query Parameters

  • send_double_opt_instring · enum
    Enum values:
    true
    false
    new
    not_active
    Default: false
  • resubscribeboolean
    Default: true
  • account_idinteger · min: 1

​Add a contact › Request Body

  • emailstring · email · required
  • custom_attributesobject[]

​Add a contact › Responses

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

​Show contacts of a segment

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

​Show contacts of a segment › path Parameters

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

​Show contacts of a segment › query Parameters

  • querystring
  • jsonstring · json-string
  • cursorstring
  • account_idinteger · min: 1
  • pageinteger · min: 1
    Default: 1
  • per_pageinteger · min: 1
    Default: 50
  • with_countboolean
  • sortstring
  • filterstring
  • fiqlstring

​Show contacts of a segment › Responses

    • paginationobject · required
    • dataobject[] · required

​Tags multiple contacts

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

​Tags multiple contacts › path Parameters

  • list_idinteger · min: 1 · required

​Tags multiple contacts › query Parameters

  • account_idinteger · min: 1

​Tags multiple contacts › Request Body

  • tagsstring[] · minItems: 1 · maxItems: 1024 · required
  • contact_idsinteger[] · min: 1 · minItems: 1 · maxItems: 1024
  • querystring · minLength: 1
  • fiqlstring
  • jsonobject

​Tags multiple contacts › Responses

    • taggedboolean
      Default: true

​Untags multiple contacts

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

​Untags multiple contacts › path Parameters

  • list_idinteger · min: 1 · required

​Untags multiple contacts › query Parameters

  • account_idinteger · min: 1

​Untags multiple contacts › Request Body

  • tagsstring[] · minItems: 1 · maxItems: 1024 · required
  • contact_idsinteger[] · min: 1 · minItems: 1 · maxItems: 1024
  • querystring · minLength: 1
  • fiqlstring
  • jsonobject

​Untags multiple contacts › Responses

    • untaggedboolean
      Default: true

​Show a contact details

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

​Show a contact details › path Parameters

  • list_idinteger · min: 1 · required
  • contact_idinteger · min: 1 · required

​Show a contact details › query Parameters

  • account_idinteger · min: 1

​Show a contact details › Responses

    • dataobject · required

​Delete a contact

DELETE
https://api.cakemail.dev
/lists/{list_id}/contacts/{contact_id}

​Delete a contact › path Parameters

  • list_idinteger · min: 1 · required
  • contact_idinteger · min: 1 · required

​Delete a contact › query Parameters

  • account_idinteger · min: 1

​Delete a contact › Responses

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

​Update a contact

PATCH
https://api.cakemail.dev
/lists/{list_id}/contacts/{contact_id}

​Update a contact › path Parameters

  • list_idinteger · min: 1 · required
  • contact_idinteger · min: 1 · required

​Update a contact › query Parameters

  • account_idinteger · min: 1

​Update a contact › Request Body

  • emailstring · email
  • custom_attributesobject[]
  • interestsstring[]
  • tagsstring[]

​Update a contact › Responses

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

​Import contacts

POST
https://api.cakemail.dev
/lists/{list_id}/import-contacts

​Import contacts › path Parameters

  • list_idinteger · min: 1 · required

​Import contacts › query Parameters

  • send_double_opt_instring · enum
    Enum values:
    true
    false
    new
    not_active
    Default: false
  • account_idinteger · min: 1

​Import contacts › Request Body

  • contactsobject[] · minItems: 1 · required
  • import_tostring · enum
    Enum values:
    active
    unsubscribed
    deleted
  • resubscribeboolean
  • remove_tagsboolean
    Default: true
  • remove_interestsboolean
    Default: true

​Import contacts › Responses

    • idinteger[] · required
    • import_idstring · uuid4
    • objectstring
      Default: contact
    • importedboolean
      Default: true
    • dataobject[]
      Default: []
    • errorsarray

​Unsubscribe a contact from a list

POST
https://api.cakemail.dev
/lists/{list_id}/contacts/{contact_id}/unsubscribe

​Unsubscribe a contact from a list › path Parameters

  • list_idinteger · min: 1 · required
  • contact_idinteger · min: 1 · required

​Unsubscribe a contact from a list › query Parameters

  • account_idinteger · min: 1

​Unsubscribe a contact from a list › Responses

    • dataobject · required
    • objectstring
      Default: contact
    • subscribedboolean
deprecated

​Tags a contact

POST
https://api.cakemail.dev
/lists/{list_id}/contacts/{contact_id}/tag

​Tags a contact › path Parameters

  • list_idinteger · min: 1 · required
  • contact_idinteger · min: 1 · required

​Tags a contact › query Parameters

  • account_idinteger · min: 1

​Tags a contact › Request Body

  • tagsstring[] · minItems: 1 · maxItems: 1024 · required

​Tags a contact › Responses

    • taggedboolean
      Default: true
deprecated

​Untags a contact

POST
https://api.cakemail.dev
/lists/{list_id}/contacts/{contact_id}/untag

​Untags a contact › path Parameters

  • list_idinteger · min: 1 · required
  • contact_idinteger · min: 1 · required

​Untags a contact › query Parameters

  • account_idinteger · min: 1

​Untags a contact › Request Body

  • tagsstring[] · minItems: 1 · maxItems: 1024 · required

​Untags a contact › Responses

    • untaggedboolean
      Default: true

​Remove interest(s) from contact(s)

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

​Remove interest(s) from contact(s) › path Parameters

  • list_idinteger · min: 1 · required

​Remove interest(s) from contact(s) › query Parameters

  • account_idinteger · min: 1

​Remove interest(s) from contact(s) › Request Body

  • interestsstring[] · maxItems: 16 · required
  • contact_idsinteger[] · min: 1 · maxItems: 1024
  • querystring
  • fiqlstring
  • jsonobject

​Remove interest(s) from contact(s) › Responses

    • objectstring
      Default: interests
    • removedboolean
      Default: true

​Show all Contacts Exports

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

​Show all Contacts Exports › path Parameters

  • list_idinteger · min: 1 · required

​Show all Contacts Exports › query Parameters

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

​Show all Contacts Exports › Responses

    • paginationobject · required
    • dataobject[] · required

​Create a Contacts Export

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

​Create a Contacts Export › path Parameters

  • list_idinteger · min: 1 · required

​Create a Contacts Export › query Parameters

  • descriptionstring
  • querystring
  • jsonstring · json-string
  • segment_idinteger · min: 1
  • account_idinteger · min: 1
  • filterstring
  • fiqlstring

​Create a Contacts Export › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: task
    • createdboolean
      Default: true

​Show a Contacts Export

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

​Show a Contacts Export › path Parameters

  • export_idstring · required
  • list_idinteger · min: 1 · required

​Show a Contacts Export › query Parameters

  • account_idinteger · min: 1

​Show a Contacts Export › Responses

    • dataobject · required

​Delete a Contacts Export

DELETE
https://api.cakemail.dev
/lists/{list_id}/exports/{export_id}

​Delete a Contacts Export › path Parameters

  • export_idstring · required
  • list_idinteger · min: 1 · required

​Delete a Contacts Export › query Parameters

  • account_idinteger · min: 1

​Delete a Contacts Export › Responses

    • idstring · required
    • dataobject · required
    • objectstring
      Default: contactsexport
    • deletedboolean
      Default: true

​Download a Contacts Export

GET
https://api.cakemail.dev
/lists/{list_id}/exports/{export_id}/download

​Download a Contacts Export › path Parameters

  • export_idstring · required
  • list_idinteger · min: 1 · required

​Download a Contacts Export › query Parameters

  • account_idinteger · min: 1

​Download a Contacts Export › Responses

    • dataobject · required
Campaign BlueprintCustom Attribute