import { Crevio } from "@crevio/sdk";
const crevio = new Crevio({
apiKey: process.env["CREVIO_API_KEY"] ?? "",
});
async function run() {
const result = await crevio.experiences.update({
idOrSlug: "<value>",
experienceUpdateRequest: {},
});
console.log(result);
}
run();curl --request PATCH \
--url https://api.crevio.co/v1/experiences/{id_or_slug} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"details": {
"description": "<string>",
"require_lesson_completion": true,
"instructor": {
"name": "<string>",
"title": "<string>",
"bio": "<string>"
}
}
}
'import requests
url = "https://api.crevio.co/v1/experiences/{id_or_slug}"
payload = {
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"details": {
"description": "<string>",
"require_lesson_completion": True,
"instructor": {
"name": "<string>",
"title": "<string>",
"bio": "<string>"
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
slug: '<string>',
details: {
description: '<string>',
require_lesson_completion: true,
instructor: {name: '<string>', title: '<string>', bio: '<string>'}
}
})
};
fetch('https://api.crevio.co/v1/experiences/{id_or_slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.crevio.co/v1/experiences/{id_or_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'slug' => '<string>',
'details' => [
'description' => '<string>',
'require_lesson_completion' => true,
'instructor' => [
'name' => '<string>',
'title' => '<string>',
'bio' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.crevio.co/v1/experiences/{id_or_slug}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"details\": {\n \"description\": \"<string>\",\n \"require_lesson_completion\": true,\n \"instructor\": {\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"bio\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.crevio.co/v1/experiences/{id_or_slug}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"details\": {\n \"description\": \"<string>\",\n \"require_lesson_completion\": true,\n \"instructor\": {\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"bio\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crevio.co/v1/experiences/{id_or_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"details\": {\n \"description\": \"<string>\",\n \"require_lesson_completion\": true,\n \"instructor\": {\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"bio\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"access_type": "secret",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "<string>",
"active_grants_count": 123,
"details": {}
}{
"error": {
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request was malformed or contained invalid parameters"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "You did not provide an API key."
}
}{
"error": {
"type": "invalid_request_error",
"code": "forbidden",
"message": "You do not have permission to perform this action"
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "The requested resource was not found"
}
}{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Email is required",
"errors": {
"email": [
"can't be blank"
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry later."
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred"
}
}Update experience
Updates an experience’s base fields and, via details, its type-specific item fields. Collection content (chapters, lessons, link items, posts, event sessions) has its own nested endpoints and is not touched here.
import { Crevio } from "@crevio/sdk";
const crevio = new Crevio({
apiKey: process.env["CREVIO_API_KEY"] ?? "",
});
async function run() {
const result = await crevio.experiences.update({
idOrSlug: "<value>",
experienceUpdateRequest: {},
});
console.log(result);
}
run();curl --request PATCH \
--url https://api.crevio.co/v1/experiences/{id_or_slug} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"details": {
"description": "<string>",
"require_lesson_completion": true,
"instructor": {
"name": "<string>",
"title": "<string>",
"bio": "<string>"
}
}
}
'import requests
url = "https://api.crevio.co/v1/experiences/{id_or_slug}"
payload = {
"name": "<string>",
"description": "<string>",
"slug": "<string>",
"details": {
"description": "<string>",
"require_lesson_completion": True,
"instructor": {
"name": "<string>",
"title": "<string>",
"bio": "<string>"
}
}
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
slug: '<string>',
details: {
description: '<string>',
require_lesson_completion: true,
instructor: {name: '<string>', title: '<string>', bio: '<string>'}
}
})
};
fetch('https://api.crevio.co/v1/experiences/{id_or_slug}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.crevio.co/v1/experiences/{id_or_slug}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'description' => '<string>',
'slug' => '<string>',
'details' => [
'description' => '<string>',
'require_lesson_completion' => true,
'instructor' => [
'name' => '<string>',
'title' => '<string>',
'bio' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.crevio.co/v1/experiences/{id_or_slug}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"details\": {\n \"description\": \"<string>\",\n \"require_lesson_completion\": true,\n \"instructor\": {\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"bio\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.crevio.co/v1/experiences/{id_or_slug}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"details\": {\n \"description\": \"<string>\",\n \"require_lesson_completion\": true,\n \"instructor\": {\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"bio\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.crevio.co/v1/experiences/{id_or_slug}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"slug\": \"<string>\",\n \"details\": {\n \"description\": \"<string>\",\n \"require_lesson_completion\": true,\n \"instructor\": {\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"bio\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "<string>",
"name": "<string>",
"slug": "<string>",
"description": "<string>",
"access_type": "secret",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"type": "<string>",
"active_grants_count": 123,
"details": {}
}{
"error": {
"type": "invalid_request_error",
"code": "bad_request",
"message": "The request was malformed or contained invalid parameters"
}
}{
"error": {
"type": "invalid_request_error",
"code": "authentication_required",
"message": "You did not provide an API key."
}
}{
"error": {
"type": "invalid_request_error",
"code": "forbidden",
"message": "You do not have permission to perform this action"
}
}{
"error": {
"type": "invalid_request_error",
"code": "resource_missing",
"message": "The requested resource was not found"
}
}{
"error": {
"type": "validation_error",
"code": "validation_failed",
"message": "Email is required",
"errors": {
"email": [
"can't be blank"
]
}
}
}{
"error": {
"type": "invalid_request_error",
"code": "rate_limit_exceeded",
"message": "Too many requests. Please retry later."
}
}{
"error": {
"type": "api_error",
"code": "internal_error",
"message": "An unexpected error occurred"
}
}Authorizations
API key in the format: Bearer {api_token}
Path Parameters
The resource prefix ID (e.g., "prod_abc123") or slug (e.g., "my-product")
Body
Short description (max 200 chars)
secret (access via grant/purchase) or open (visible to members)
secret, open URL slug, unique within the account
Type-specific fields. The accepted shape is determined by the experience's type (see the per-type schemas). Collection content (chapters, link items, topics, posts, event sessions) has its own nested endpoints. Link, Discord, Telegram, and Event types take no details.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
Show child attributes
Show child attributes
Response
Experience updated
secret, open Type-specific fields, shaped by the experience's type. Mirrors what PATCH accepts under details (see the per-type *DetailsRequest schemas), plus read-only collections (e.g. a course's chapters).
Was this page helpful?

