Skip to main content
POST
/
experiences
/
{id}
/
attach
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const experience = await client.experiences.attach('exp_xxxxxxxxxxxxxx', {
  product_id: 'prod_xxxxxxxxxxxxx',
});

console.log(experience.id);
{
  "id": "exp_xxxxxxxxxxxxxx",
  "name": "Trading Signals Chat",
  "order": "123.45",
  "is_public": true,
  "created_at": "2023-12-01T05:00:00.401Z",
  "app": {
    "id": "app_xxxxxxxxxxxxxx",
    "name": "Courses",
    "icon": {
      "url": "https://media.whop.com/abc123/optimized.jpg"
    }
  },
  "image": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "Pickaxe",
    "route": "pickaxe"
  },
  "products": [
    {
      "id": "prod_xxxxxxxxxxxxx",
      "route": "pickaxe-analytics",
      "title": "Pickaxe Analytics"
    }
  ]
}

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 ***************************

Path Parameters

​
id
string
required

The unique identifier of the experience to attach.

Example:

"exp_xxxxxxxxxxxxxx"

Body

application/json

Parameters for AddExperienceToAccessPass

​
product_id
string
required

The unique identifier of the product to attach the experience to.

Example:

"prod_xxxxxxxxxxxxx"

Response

A successful response

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

​
id
string
required

The unique identifier for the experience.

Example:

"exp_xxxxxxxxxxxxxx"

​
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"

​
is_public
boolean
required

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

​
created_at
string<date-time>
required

The datetime the experience was created.

Example:

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

​
app
object
required

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

​
image
object
required

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

​
company
object
required

The company that owns this experience.

​
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.