Skip to main content
POST
/
apps
Create
curl --request POST \
  --url https://apimgmt.cometchat.io/apps \
  --header 'Content-Type: application/json' \
  --header 'key: <key>' \
  --header 'secret: <secret>' \
  --data '
{
  "name": "<string>",
  "region": "us",
  "version": "3",
  "skipSampleData": true
}
'
{
  "data": {
    "id": "<APP_ID>",
    "name": "<App Name>",
    "plan": "trial",
    "trialEndsAt": 1588887393,
    "state": "active",
    "owner": 1656,
    "region": "us",
    "createdAt": 1586295393,
    "appOwner": {
      "id": "1656",
      "name": "<OWNER_NAME>",
      "email": "youremail@domain.com"
    },
    "appRegion": {
      "id": "us",
      "name": "USA",
      "description": "The USA region has serverslocated at Ohio."
    },
    "apiKeys": {
      "<API_KEY1>": {
        "apiKey": "<API_KEY1>",
        "name": "Rest API Key",
        "scope": "fullAccess",
        "createdBy": "app_system"
      },
      "<API_KEY2>": {
        "apiKey": "<API_KEY2>",
        "name": "Auth Key",
        "scope": "authOnly",
        "createdBy": "app_system"
      }
    }
  }
}

​
Constraints

ItemConstraintNotes
App name100 characters (UTF8mb4)Supports all languages and emojis
App versionv3Only option available
Maximum collaborators per app25Team management limit
For the complete error reference, see Error Guide.

Headers

​
key
string
required

Authorization Key

​
secret
string
required

Authorization Secret

Body

application/json
​
name
string
required

name of the app.

​
region
enum<string>
default:us
required

Region of the app

Available options:
us,
eu,
in
​
version
string
default:3

version of an app

​
skipSampleData
boolean

skips sample data if it is set true

Response

200 - application/json

Created App

​
data
object