Skip to main content
POST
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Body

application/json

Parameters for CreateExperience

app_id
string
required

The unique identifier of the app that powers this experience.

Example:

"app_xxxxxxxxxxxxxx"

company_id
string
required

The unique identifier of the company to create this experience for.

Example:

"biz_xxxxxxxxxxxxxx"

is_public
boolean | null

Whether the experience is publicly accessible without a membership.

logo
FileInputWithId · object | null

A logo image displayed alongside the experience name.

name
string | null

The display name of the experience. Defaults to the app's name if not provided.

section_id
string | null

The unique identifier of the section to place the experience in.

Response

A successful response

An experience is a feature or content module within a product, such as a chat, course, or custom app.

app
object
required

The app that powers this experience, defining its interface and behavior.

company
object
required

The company that owns this experience.

created_at
string<date-time>
required

The datetime the experience was created.

Example:

"2023-12-01T05:00:00.401Z"

id
string
required

The unique identifier for the experience.

Example:

"exp_xxxxxxxxxxxxxx"

image
object | null
required

The custom logo image for this experience. Null if no custom logo has been uploaded.

is_public
boolean
required

Whether this experience is publicly visible to all users, including those without a membership.

name
string
required

The display name of this experience shown to users in the product navigation. Maximum 255 characters.

Example:

"Trading Signals Chat"

order
string | null
required

The sort position of this experience within its section. Lower values appear first. Null if no position has been set.

Example:

"123.45"

products
object[]
required

The list of products this experience is attached to, which determines which customers have access. Empty if the experience is only visible to authorized company team members.