Get opt-out categories API

This API is used to get the list of optout-categories.

📘

Know your endpoint

Based on the domain you use to log in to Webex Campaign, the endpoint domain for your API varies. For more information, refer to the Know Your API Endpoints section.

Go to the Postman Collection section to learn how to import a Postman collection. Click the below button, If you already know how to import a postman collection.

Headers

The following table describes the request headers:

Request Example

https://<yourdomain>.webexcampaign.io/campaignapi/resources/v3/optout-categories

Response Example

[
    {
        "categoryName": "emailCategory",
        "storeName": "surya_emailCategory",
        "unsubListCategoryLabel": "CATEGORY emailCategory UNSUBLINK"
    },
    {
        "categoryName": "emailCategory2",
        "storeName": "surya_emailCategory2",
        "unsubListCategoryLabel": "CATEGORY emailCategory2 UNSUBLINK"
    },
    {
        "categoryName": "EmailOptOutManagement",
        "storeName": "surya_EmailOptOutManagement",
        "unsubListCategoryLabel": "CATEGORY EmailOptOutManagement UNSUBLINK"
    }
  ]

Response Parameters

This API will return the following response parameters:

Failure Response Codes

The API will return code within the response as per the following table in case of failure scenarios.