Skip to main content
POST
/
tenants
Add Tenant
curl --request POST \
  --url https://apimgmt.cometchat.io/tenants \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Example User",
  "email": "my-email@example.com",
  "password": "somePassword#!",
  "contactNumber": "1234567890",
  "role": "engineer",
  "appName": "Create App",
  "appRegion": "us"
}'
{
  "data": {
    "name": "Sachin Bahukhandi",
    "email": "sachin.bahukhandi+113@cometchat.com",
    "createdAt": 1715947984,
    "contactNumber": "8936985734",
    "app": {
      "name": "Create APP",
      "appId": "2531446b588709f6",
      "region": "us",
      "authKey": "05753974edb58b7ce7c1ab10eb3eb3033e3dd1e9",
      "apiKey": "5db447476272190a2cda793e10e59f58bcc17317",
      "createdAt": 1715947984,
      "plan": "Build"
    }
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
​
name
string
required

Specifies the name of the customer.

​
email
string
required

Specifies the email address of the customer, this will be the account identifier

​
password
string
required

For the purpose of accessing the CometChat account, a password in plain text format is required.

​
appName
string
required

This defines the name of the application within CometChat.

​
appRegion
enum<string>
required

This refers to the selected region for the app. Users should select a region that is geographically close to their customer base for optimal performance.

Available options:
us,
eu,
in
​
contactNumber
string

This represents the user's contact number information.

​
role
string

This indicates the role associated with the created account, such as developer, product manager, business owner, and so on.

​
industry
string

This pertains to the specific domain that the app is associated with.

​
technology
string

This refers to a single-string representation of the primary technology or framework utilized by the customer, examples of which may include 'ReactJS', 'Angular', 'Vue', 'Android', 'iOS', and so on.

Response

200 - application/json

Map Settings

​
object