Overview

Manage CometChat applications at the account level with Multi-Tenancy APIs.

Welcome to CometChat’s Multi-Tenancy API documentation!
This comprehensive guide offers in-depth insights into the Multi-tenancy APIs provided by CometChat. Access to Multi-tenancy APIs is exclusive to clients with plans that support this feature. To verify feature availability in your plan, please refer to our pricing page: https://www.cometchat.com/pricing.

API Resources

Resource	Description
Apps	Create, list, delete apps, and fetch usage
Settings	List, map, and unmap app-level settings
Extensions	List, enable/disable, and configure extensions
Webhooks	Create, list, update, delete webhooks and manage triggers
Team Management	List and manage collaborators

Introduction

The Multi-Tenancy API provided by CometChat empowers users to execute a wide array of operations at the application level.
This functionality enables developers to oversee their CometChat applications at the account level through REST APIs, eliminating the need to repeatedly access the dashboard for managing operations related to their multi-tenant apps. This approach offers enhanced control and flexibility in resource management.

Getting Started

To initiate usage of CometChat’s Multi-Tenancy API, it’s necessary to reach out to the Sales team to activate it. Once activated, the Sales team will provide you with a key & secret enabling access to the Multi-Tenancy APIs.

Authentication

All API requests must be accompanied by a key & secret to authenticate the APIs.

Endpoints

CometChat’s REST API offers a variety of endpoints catering to different aspects of multi-tenant functionality, including app management, extensions management, team management, and more. These endpoints are designed to be intuitive and easy to integrate into your application’s backend infrastructure.

Example of a Create App API request in curl command syntax:

cURL

curl -X POST \
-H "Content-Type: application/json" \
-H "key: YOUR_KEY" \
-H "secret: YOUR_SECRET" \
-d '{
    "name": "Test app",
    "version": "3",
    "region": "us"
}' "https://apimgmt.cometchat.io/apps"

key and secret need to be replaced in the curl request.