Skip to main content
POST
Install an app

Authorizations

x-api-key
string
header
required

Body

application/json
teamIds
string[]
required

Array of team IDs where the app will be installed

Example:
appId
string
required

Unique identifier of the app to be installed

Example:

"9FKHF3KJ10JQTR2YJ6QW1QZTHBZ85"

appConfiguration
object
required

Configuration settings for the app installation

Response

App installed successfully

appName
string
required

Name of the installed app

Example:

"Thena.ai"

botSub
string
required

Bot subscriber ID

Example:

"OGGA0557MV"

botTokenKey
string
required

Bot token key for authentication

Example:

"pk_live_*******_*******"

botToken
string
required

Bot token for authentication

Example:

"pk_live_*******_*******"

installedBySub
string
required

Subscriber ID of the user who installed the app

Example:

"UGGA0557MV"

installedByEmail
string
required

Email of the user who installed the app

Example:

"john.doe@example.com"

appInstalledForTeams
string[]
required

List of team IDs where the app is installed

Example:
appIdentifier
string
required

Identifier of the app

Example:

"thena-ai"

installedByOrgId
string
required

Organization ID of the user who installed the app

Example:

"OGGA0557MV"

metadata
object
required

Metadata of the app

Example: