Get Topics

Use this API to get a list of all the topics available in your Zoho Campaigns account.

Request Type:

  • GET    

Scope:

  • ZohoCampaigns.contact.READ    

Request URL:

  • https://campaigns.zoho.com/api/v1.1/topics    

API Limit

  • Duration: 5 mins
  • Number of Calls: 500
  • Lock Period: 30 mins

You can send 500 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of Parameters --Version 1.1

                    Parameter                

                    Data Type                

                    Description                

                    from_index                

                    Integer                

                    Range of topics to be returned to the user                

                    range                

                    Integer                

                    Range of topics to be returned to the user                

Possible error cases  

Error Code                

Description                

4010                

No privilege                

4011                

Topic name cannot contain special characters                

4012                

Topic description cannot contain special characters                

4013                

Topic name already exists                

4014                

Product ID associated to topic is invalid

4015Users belong to the Brand topic model

4016                

The topic associated with contacts not enabled                

4017Topic name cannot be empty
4018Topic description cannot be empty
4019Product ID is mandatory for brand product topic creation

If your error code is not listed above, click here.

Sample Request

Copiedhttps://campaigns.zoho.com/api/v1.1/topics?details={from_index:0,range:1}

Sample Response

Copied{
    "topicDetails": [
        {
            "topicId": "80696000000044001",
            "primaryList": 80696000000044003,
            "topicName": "default"
        }
    ],
    "code": "200",
    "message": "Success",
    "uri": "/api/v1.1/topics"
}