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

const client = new Whop({
  appID: 'app_xxxxxxxxxxxxxx',
  apiKey: 'My API Key',
});

const experience = await client.experiences.update('exp_xxxxxxxxxxxxxx');

console.log(experience.id);
{
  "id": "exp_xxxxxxxxxxxxxx",
  "name": "<string>",
  "order": "123.45",
  "created_at": "2023-12-01T05:00:00.401Z",
  "app": {
    "id": "app_xxxxxxxxxxxxxx",
    "name": "<string>",
    "icon": {
      "url": "<string>"
    }
  },
  "image": {
    "url": "<string>"
  },
  "company": {
    "id": "biz_xxxxxxxxxxxxxx",
    "title": "<string>",
    "route": "<string>"
  },
  "products": [
    {
      "id": "prod_xxxxxxxxxxxxx",
      "route": "<string>",
      "title": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required
Example:

"exp_xxxxxxxxxxxxxx"

Body

application/json

Parameters for UpdateExperience

​
access_level
enum<string> | null

The access level of the experience. The different access levels for experiences (PUBLIC IS NEVER USED ANYMORE).

Available options:
public,
private

The logo for the experience Input for an attachment

  • AttachmentInputWithDirectUploadId
  • AttachmentInputWithId
​
name
string | null

The name of the experience.

​
order
string | null

The order of the experience in the section.

Example:

"123.45"

​
section_id
string | null

The ID of the section to update.

Response

A successful response

An object representing an experience belonging to a company.

​
id
string
required

The unique ID representing this experience

Example:

"exp_xxxxxxxxxxxxxx"

​
name
string
required

The written name of the description.

​
order
string | null
required

The order of the experience in the section

Example:

"123.45"

​
created_at
string<date-time>
required

The timestamp of when this experience was created.

Example:

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

​
app
object
required

The experience interface for this experience.

​
image
object | null
required

The logo for the experience.

​
company
object
required

The company that owns this experience.

​
products
object[]
required

The access passes that are associated with this experience. This should not be used unless you are trying to list all access passes the experience has, for some reason. You probably don't want to use this though and should be using accessPass.