v8

OpenAPI 3.1.02026-08-033623795.0 MB
Experiences

Attach experience

Attach an experience to a product, making it accessible to the product's customers.

Required permissions:

  • experience:attach
post/experiences/{id}/attach

Path parameters

idstring required
Example:exp_xxxxxxxxxxxxxx

The unique identifier of the experience to attach.

Request body

product_idstring required

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

Example request

{
  "product_id": "prod_xxxxxxxxxxxxx"
}

Response

A successful response

created_atstring date-time required

The datetime the experience was created.

idstring required

The unique identifier for the experience.

is_publicboolean required

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

namestring required

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

orderstring nullable required

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

Example response

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