Skip to main content
POST
/
installations
Create an installation
curl --request POST \
  --url https://api-dev.narrative.io/installations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "app_id": 67,
  "tier_id": "basic"
}
'
{
  "id": 12345,
  "app_id": 67,
  "company_id": 345,
  "tier_id": "basic",
  "permissions": [
    {
      "access": "read",
      "resource": "datasets"
    },
    {
      "access": "write",
      "resource": "destinations"
    }
  ],
  "installation_time": "2024-01-15T10:30:00"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for creating a new installation.

app_id
integer<int64>
required

The ID of the app to install.

Example:

67

tier_id
string
required

The tier to use for the installation. Must be a valid tier ID from the app's manifest.

Example:

"basic"

Response

Successfully created the installation.

An installation represents an app that has been installed for a company.

id
integer<int64>
required

Unique identifier for the installation.

Example:

12345

app_id
integer<int64>
required

The ID of the installed app.

Example:

67

company_id
integer<int64>
required

The ID of the company that installed the app.

Example:

345

tier_id
string
required

The tier selected during installation.

Example:

"basic"

permissions
object[]
required

The permissions granted to this installation.

installation_time
string<date-time>
required

The timestamp when the installation occurred.

Example:

"2024-01-15T10:30:00"