Link

Categories

Categories are determined by the main interests your organization covers within its content. Subscribers will select Categories they are interested in and not interested in when they personalize their Cerkl profile via the Welcome Email they will receive upon subscription. Cerkl will also suggest new Categories based upon the interests of your Audience and the keywords our AI will compare your Content with.

You can add Categories to your Stories, Events, and Needs, allowing you to direct your Content towards the Subscribers most likely to engage with it.

Adding New Categories

If you would like to add a new Category, make a POST request to the /category endpoint that specifies its name in the description field:

    $ curl --request POST 'api.cerkl.com/v3/category' \
        --header 'Content-Type: application/json' \
        --header 'Authorization: Bearer {ACCESS_TOKEN}' \
        --data-raw '{
            "template": {
                "version": "3.0",
                "data": [
                    {
                        "description": "Engineering"
                    }
                ]
            }
        }'

Now you have a new Category your organization’s communicators can add to your Cerkl Content!

Getting Categories

Categories can be retrieved like all other Cerkl objects by using a GET request on the /category endpoint:

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

In order to retrieve a specific Category, you can use the GET method on the /category/{id} endpoint, specifying your Category via its integer id value. As an example, let’s say our newly created Category from above was given an id of 554. That request would look like this:

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

Deleting Categories

Categories can be deleted using the DELETE method on the /category/{id} endpoint, where id specifies the Category to be removed. If your Category’s id value is still 554, that looks like this:

    $ curl --request DELETE 'api.cerkl.com/v3/category/554' \
        --header 'Authorization: Bearer {ACCESS_TOKEN}'