Unsubscribes

When Subscribers are “deleted” or unsubscribed from your organization’s Cerkl, they don’t disappear entirely. Cerkl keeps a record of all unsubscribed Subscribers in order to track that they have been Subscribers at some point but aren’t anymore (for whatever reason). This prevents users who opt out of communications from Cerkl from receiving any Cerkl messages.

Because these “Unsubscribers” are kept in our database, you can retrieve them to inspect who is no longer Subscribed to your Cerkl instance.

Getting All Unsubscribes

To get all of your Cerkl’s Unsubscribes, use the GET method on the /unsubscribe endpoint:

    $ curl --request GET 'api.cerkl.com/v3/unsubscribe' \
        --header 'Authorization: Bearer {ACCESS_TOKEN}'

Getting Specific Unsubscribes

In order to retrieve specific Unsubscribes, you can make a GET request to the /unsubscribe/{id} endpoint, supplying an id integer value that corresponds to a specific Subscriber that was Unsubscribed. Unsubscribe objects retain the id values of the Subscriber objects they were originally.

For example, if a Subscriber with an id value of 12345 is unsubscribed, it becomes an Unsubscribe object with the same id:

    $ curl --request GET 'api.cerkl.com/v3/unsubscribe/12345' \
        --header 'Authorization: Bearer {ACCESS_TOKEN}'