Edit a page an operation at a time
curl --request PATCH \
--url http://localhost:3000/api/v1/brands/{slug}/pages/{page} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ops": [
{
"op": "add",
"section": {
"id": "<string>",
"title": "<string>",
"body": "<string>",
"columns": 2,
"hidden": true,
"keys": [
"<string>"
],
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 0.45
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": true,
"span": 1,
"at": [
50,
50
],
"level": 1
}
],
"contexts": [
"<string>"
],
"only": "<string>",
"translations": {},
"props": {
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"video": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strip": true,
"flip": true,
"show": [],
"matrix": true,
"ase": true,
"simulate": true,
"sample": "<string>",
"roles": true,
"glyphs": true,
"embed": true,
"kit": true,
"ask": true,
"collection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"search": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"query": "<string>",
"limit": 100,
"downloads": true,
"from": "<string>",
"depth": 2,
"positions": [],
"partner": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scales": [
5.05
],
"form": [
{
"name": "<string>",
"label": "<string>"
}
],
"template": "<string>",
"url": "<string>",
"prompt": "<string>"
}
},
"after": "<string>"
}
]
}
'import requests
url = "http://localhost:3000/api/v1/brands/{slug}/pages/{page}"
payload = { "ops": [
{
"op": "add",
"section": {
"id": "<string>",
"title": "<string>",
"body": "<string>",
"columns": 2,
"hidden": True,
"keys": ["<string>"],
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 0.45
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": True,
"span": 1,
"at": [50, 50],
"level": 1
}
],
"contexts": ["<string>"],
"only": "<string>",
"translations": {},
"props": {
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"video": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strip": True,
"flip": True,
"show": [],
"matrix": True,
"ase": True,
"simulate": True,
"sample": "<string>",
"roles": True,
"glyphs": True,
"embed": True,
"kit": True,
"ask": True,
"collection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"search": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"query": "<string>",
"limit": 100,
"downloads": True,
"from": "<string>",
"depth": 2,
"positions": [],
"partner": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scales": [5.05],
"form": [
{
"name": "<string>",
"label": "<string>"
}
],
"template": "<string>",
"url": "<string>",
"prompt": "<string>"
}
},
"after": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ops: [
{
op: 'add',
section: {
id: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
columns: 2,
hidden: true,
keys: ['<string>'],
eyebrow: '<string>',
lede: '<string>',
aside: '<string>',
tab: '<string>',
background: {color: '<string>', image: '3c90c3cc-0d44-4b50-8888-8dd25736052a', scrim: 0.45},
items: [
{
key: '<string>',
asset: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
text: '<string>',
caption: '<string>',
link: '<string>',
label: '<string>',
icon: '<string>',
download: true,
span: 1,
at: [50, 50],
level: 1
}
],
contexts: ['<string>'],
only: '<string>',
translations: {},
props: {
image: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
video: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
strip: true,
flip: true,
show: [],
matrix: true,
ase: true,
simulate: true,
sample: '<string>',
roles: true,
glyphs: true,
embed: true,
kit: true,
ask: true,
collection: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
search: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
query: '<string>',
limit: 100,
downloads: true,
from: '<string>',
depth: 2,
positions: [],
partner: '<string>',
asset: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scales: [5.05],
form: [{name: '<string>', label: '<string>'}],
template: '<string>',
url: '<string>',
prompt: '<string>'
}
},
after: '<string>'
}
]
})
};
fetch('http://localhost:3000/api/v1/brands/{slug}/pages/{page}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/brands/{slug}/pages/{page}",
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([
'ops' => [
[
'op' => 'add',
'section' => [
'id' => '<string>',
'title' => '<string>',
'body' => '<string>',
'columns' => 2,
'hidden' => true,
'keys' => [
'<string>'
],
'eyebrow' => '<string>',
'lede' => '<string>',
'aside' => '<string>',
'tab' => '<string>',
'background' => [
'color' => '<string>',
'image' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scrim' => 0.45
],
'items' => [
[
'key' => '<string>',
'asset' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'text' => '<string>',
'caption' => '<string>',
'link' => '<string>',
'label' => '<string>',
'icon' => '<string>',
'download' => true,
'span' => 1,
'at' => [
50,
50
],
'level' => 1
]
],
'contexts' => [
'<string>'
],
'only' => '<string>',
'translations' => [
],
'props' => [
'image' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'video' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'strip' => true,
'flip' => true,
'show' => [
],
'matrix' => true,
'ase' => true,
'simulate' => true,
'sample' => '<string>',
'roles' => true,
'glyphs' => true,
'embed' => true,
'kit' => true,
'ask' => true,
'collection' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'search' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'query' => '<string>',
'limit' => 100,
'downloads' => true,
'from' => '<string>',
'depth' => 2,
'positions' => [
],
'partner' => '<string>',
'asset' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scales' => [
5.05
],
'form' => [
[
'name' => '<string>',
'label' => '<string>'
]
],
'template' => '<string>',
'url' => '<string>',
'prompt' => '<string>'
]
],
'after' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/v1/brands/{slug}/pages/{page}"
payload := strings.NewReader("{\n \"ops\": [\n {\n \"op\": \"add\",\n \"section\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"columns\": 2,\n \"hidden\": true,\n \"keys\": [\n \"<string>\"\n ],\n \"eyebrow\": \"<string>\",\n \"lede\": \"<string>\",\n \"aside\": \"<string>\",\n \"tab\": \"<string>\",\n \"background\": {\n \"color\": \"<string>\",\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scrim\": 0.45\n },\n \"items\": [\n {\n \"key\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"caption\": \"<string>\",\n \"link\": \"<string>\",\n \"label\": \"<string>\",\n \"icon\": \"<string>\",\n \"download\": true,\n \"span\": 1,\n \"at\": [\n 50,\n 50\n ],\n \"level\": 1\n }\n ],\n \"contexts\": [\n \"<string>\"\n ],\n \"only\": \"<string>\",\n \"translations\": {},\n \"props\": {\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"video\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"strip\": true,\n \"flip\": true,\n \"show\": [],\n \"matrix\": true,\n \"ase\": true,\n \"simulate\": true,\n \"sample\": \"<string>\",\n \"roles\": true,\n \"glyphs\": true,\n \"embed\": true,\n \"kit\": true,\n \"ask\": true,\n \"collection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"search\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"query\": \"<string>\",\n \"limit\": 100,\n \"downloads\": true,\n \"from\": \"<string>\",\n \"depth\": 2,\n \"positions\": [],\n \"partner\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scales\": [\n 5.05\n ],\n \"form\": [\n {\n \"name\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"template\": \"<string>\",\n \"url\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n },\n \"after\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/v1/brands/{slug}/pages/{page}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ops\": [\n {\n \"op\": \"add\",\n \"section\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"columns\": 2,\n \"hidden\": true,\n \"keys\": [\n \"<string>\"\n ],\n \"eyebrow\": \"<string>\",\n \"lede\": \"<string>\",\n \"aside\": \"<string>\",\n \"tab\": \"<string>\",\n \"background\": {\n \"color\": \"<string>\",\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scrim\": 0.45\n },\n \"items\": [\n {\n \"key\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"caption\": \"<string>\",\n \"link\": \"<string>\",\n \"label\": \"<string>\",\n \"icon\": \"<string>\",\n \"download\": true,\n \"span\": 1,\n \"at\": [\n 50,\n 50\n ],\n \"level\": 1\n }\n ],\n \"contexts\": [\n \"<string>\"\n ],\n \"only\": \"<string>\",\n \"translations\": {},\n \"props\": {\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"video\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"strip\": true,\n \"flip\": true,\n \"show\": [],\n \"matrix\": true,\n \"ase\": true,\n \"simulate\": true,\n \"sample\": \"<string>\",\n \"roles\": true,\n \"glyphs\": true,\n \"embed\": true,\n \"kit\": true,\n \"ask\": true,\n \"collection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"search\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"query\": \"<string>\",\n \"limit\": 100,\n \"downloads\": true,\n \"from\": \"<string>\",\n \"depth\": 2,\n \"positions\": [],\n \"partner\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scales\": [\n 5.05\n ],\n \"form\": [\n {\n \"name\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"template\": \"<string>\",\n \"url\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n },\n \"after\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/brands/{slug}/pages/{page}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ops\": [\n {\n \"op\": \"add\",\n \"section\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"columns\": 2,\n \"hidden\": true,\n \"keys\": [\n \"<string>\"\n ],\n \"eyebrow\": \"<string>\",\n \"lede\": \"<string>\",\n \"aside\": \"<string>\",\n \"tab\": \"<string>\",\n \"background\": {\n \"color\": \"<string>\",\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scrim\": 0.45\n },\n \"items\": [\n {\n \"key\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"caption\": \"<string>\",\n \"link\": \"<string>\",\n \"label\": \"<string>\",\n \"icon\": \"<string>\",\n \"download\": true,\n \"span\": 1,\n \"at\": [\n 50,\n 50\n ],\n \"level\": 1\n }\n ],\n \"contexts\": [\n \"<string>\"\n ],\n \"only\": \"<string>\",\n \"translations\": {},\n \"props\": {\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"video\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"strip\": true,\n \"flip\": true,\n \"show\": [],\n \"matrix\": true,\n \"ase\": true,\n \"simulate\": true,\n \"sample\": \"<string>\",\n \"roles\": true,\n \"glyphs\": true,\n \"embed\": true,\n \"kit\": true,\n \"ask\": true,\n \"collection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"search\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"query\": \"<string>\",\n \"limit\": 100,\n \"downloads\": true,\n \"from\": \"<string>\",\n \"depth\": 2,\n \"positions\": [],\n \"partner\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scales\": [\n 5.05\n ],\n \"form\": [\n {\n \"name\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"template\": \"<string>\",\n \"url\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n },\n \"after\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"brand": "<string>",
"page": {
"slug": "<string>",
"title": "<string>",
"position": 0,
"hidden": true,
"parent": "<string>",
"eyebrow": "<string>",
"lede": "<string>",
"cover": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"icon": "<string>",
"audience": "everyone",
"tabs": true,
"aliases": [
"<string>"
],
"layout": "book",
"updatedAt": "2023-11-07T05:31:56Z",
"sections": [
{
"id": "<string>",
"template": "<string>",
"title": "<string>",
"body": "<string>",
"width": "text",
"columns": 0,
"tone": "<string>",
"hidden": true,
"keys": [
"<string>"
],
"props": {},
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 123
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"verdict": "do",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": true
}
],
"audience": "everyone",
"contexts": [
"<string>"
],
"only": "<string>",
"translations": {}
}
],
"translations": {}
},
"warnings": [
"<string>"
],
"url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}API Reference
Edit a page an operation at a time
ops apply in order: add, update, move and remove sections, and page for its own fields. page with slug renames it: the old slug becomes an alias that still finds it, and the pages under it follow. All or none: a 422 lists every problem with its path, e.g. ops[0].section.props.chanel: Unrecognized key.
Scope: write.
PATCH
/
api
/
v1
/
brands
/
{slug}
/
pages
/
{page}
Edit a page an operation at a time
curl --request PATCH \
--url http://localhost:3000/api/v1/brands/{slug}/pages/{page} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"ops": [
{
"op": "add",
"section": {
"id": "<string>",
"title": "<string>",
"body": "<string>",
"columns": 2,
"hidden": true,
"keys": [
"<string>"
],
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 0.45
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": true,
"span": 1,
"at": [
50,
50
],
"level": 1
}
],
"contexts": [
"<string>"
],
"only": "<string>",
"translations": {},
"props": {
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"video": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strip": true,
"flip": true,
"show": [],
"matrix": true,
"ase": true,
"simulate": true,
"sample": "<string>",
"roles": true,
"glyphs": true,
"embed": true,
"kit": true,
"ask": true,
"collection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"search": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"query": "<string>",
"limit": 100,
"downloads": true,
"from": "<string>",
"depth": 2,
"positions": [],
"partner": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scales": [
5.05
],
"form": [
{
"name": "<string>",
"label": "<string>"
}
],
"template": "<string>",
"url": "<string>",
"prompt": "<string>"
}
},
"after": "<string>"
}
]
}
'import requests
url = "http://localhost:3000/api/v1/brands/{slug}/pages/{page}"
payload = { "ops": [
{
"op": "add",
"section": {
"id": "<string>",
"title": "<string>",
"body": "<string>",
"columns": 2,
"hidden": True,
"keys": ["<string>"],
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 0.45
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": True,
"span": 1,
"at": [50, 50],
"level": 1
}
],
"contexts": ["<string>"],
"only": "<string>",
"translations": {},
"props": {
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"video": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"strip": True,
"flip": True,
"show": [],
"matrix": True,
"ase": True,
"simulate": True,
"sample": "<string>",
"roles": True,
"glyphs": True,
"embed": True,
"kit": True,
"ask": True,
"collection": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"search": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"query": "<string>",
"limit": 100,
"downloads": True,
"from": "<string>",
"depth": 2,
"positions": [],
"partner": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scales": [5.05],
"form": [
{
"name": "<string>",
"label": "<string>"
}
],
"template": "<string>",
"url": "<string>",
"prompt": "<string>"
}
},
"after": "<string>"
}
] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
ops: [
{
op: 'add',
section: {
id: '<string>',
title: '<string>',
body: JSON.stringify('<string>'),
columns: 2,
hidden: true,
keys: ['<string>'],
eyebrow: '<string>',
lede: '<string>',
aside: '<string>',
tab: '<string>',
background: {color: '<string>', image: '3c90c3cc-0d44-4b50-8888-8dd25736052a', scrim: 0.45},
items: [
{
key: '<string>',
asset: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
title: '<string>',
text: '<string>',
caption: '<string>',
link: '<string>',
label: '<string>',
icon: '<string>',
download: true,
span: 1,
at: [50, 50],
level: 1
}
],
contexts: ['<string>'],
only: '<string>',
translations: {},
props: {
image: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
video: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
strip: true,
flip: true,
show: [],
matrix: true,
ase: true,
simulate: true,
sample: '<string>',
roles: true,
glyphs: true,
embed: true,
kit: true,
ask: true,
collection: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
search: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
query: '<string>',
limit: 100,
downloads: true,
from: '<string>',
depth: 2,
positions: [],
partner: '<string>',
asset: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
scales: [5.05],
form: [{name: '<string>', label: '<string>'}],
template: '<string>',
url: '<string>',
prompt: '<string>'
}
},
after: '<string>'
}
]
})
};
fetch('http://localhost:3000/api/v1/brands/{slug}/pages/{page}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3000",
CURLOPT_URL => "http://localhost:3000/api/v1/brands/{slug}/pages/{page}",
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([
'ops' => [
[
'op' => 'add',
'section' => [
'id' => '<string>',
'title' => '<string>',
'body' => '<string>',
'columns' => 2,
'hidden' => true,
'keys' => [
'<string>'
],
'eyebrow' => '<string>',
'lede' => '<string>',
'aside' => '<string>',
'tab' => '<string>',
'background' => [
'color' => '<string>',
'image' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scrim' => 0.45
],
'items' => [
[
'key' => '<string>',
'asset' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'title' => '<string>',
'text' => '<string>',
'caption' => '<string>',
'link' => '<string>',
'label' => '<string>',
'icon' => '<string>',
'download' => true,
'span' => 1,
'at' => [
50,
50
],
'level' => 1
]
],
'contexts' => [
'<string>'
],
'only' => '<string>',
'translations' => [
],
'props' => [
'image' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'video' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'strip' => true,
'flip' => true,
'show' => [
],
'matrix' => true,
'ase' => true,
'simulate' => true,
'sample' => '<string>',
'roles' => true,
'glyphs' => true,
'embed' => true,
'kit' => true,
'ask' => true,
'collection' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'search' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'query' => '<string>',
'limit' => 100,
'downloads' => true,
'from' => '<string>',
'depth' => 2,
'positions' => [
],
'partner' => '<string>',
'asset' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'scales' => [
5.05
],
'form' => [
[
'name' => '<string>',
'label' => '<string>'
]
],
'template' => '<string>',
'url' => '<string>',
'prompt' => '<string>'
]
],
'after' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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 := "http://localhost:3000/api/v1/brands/{slug}/pages/{page}"
payload := strings.NewReader("{\n \"ops\": [\n {\n \"op\": \"add\",\n \"section\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"columns\": 2,\n \"hidden\": true,\n \"keys\": [\n \"<string>\"\n ],\n \"eyebrow\": \"<string>\",\n \"lede\": \"<string>\",\n \"aside\": \"<string>\",\n \"tab\": \"<string>\",\n \"background\": {\n \"color\": \"<string>\",\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scrim\": 0.45\n },\n \"items\": [\n {\n \"key\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"caption\": \"<string>\",\n \"link\": \"<string>\",\n \"label\": \"<string>\",\n \"icon\": \"<string>\",\n \"download\": true,\n \"span\": 1,\n \"at\": [\n 50,\n 50\n ],\n \"level\": 1\n }\n ],\n \"contexts\": [\n \"<string>\"\n ],\n \"only\": \"<string>\",\n \"translations\": {},\n \"props\": {\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"video\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"strip\": true,\n \"flip\": true,\n \"show\": [],\n \"matrix\": true,\n \"ase\": true,\n \"simulate\": true,\n \"sample\": \"<string>\",\n \"roles\": true,\n \"glyphs\": true,\n \"embed\": true,\n \"kit\": true,\n \"ask\": true,\n \"collection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"search\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"query\": \"<string>\",\n \"limit\": 100,\n \"downloads\": true,\n \"from\": \"<string>\",\n \"depth\": 2,\n \"positions\": [],\n \"partner\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scales\": [\n 5.05\n ],\n \"form\": [\n {\n \"name\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"template\": \"<string>\",\n \"url\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n },\n \"after\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://localhost:3000/api/v1/brands/{slug}/pages/{page}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"ops\": [\n {\n \"op\": \"add\",\n \"section\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"columns\": 2,\n \"hidden\": true,\n \"keys\": [\n \"<string>\"\n ],\n \"eyebrow\": \"<string>\",\n \"lede\": \"<string>\",\n \"aside\": \"<string>\",\n \"tab\": \"<string>\",\n \"background\": {\n \"color\": \"<string>\",\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scrim\": 0.45\n },\n \"items\": [\n {\n \"key\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"caption\": \"<string>\",\n \"link\": \"<string>\",\n \"label\": \"<string>\",\n \"icon\": \"<string>\",\n \"download\": true,\n \"span\": 1,\n \"at\": [\n 50,\n 50\n ],\n \"level\": 1\n }\n ],\n \"contexts\": [\n \"<string>\"\n ],\n \"only\": \"<string>\",\n \"translations\": {},\n \"props\": {\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"video\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"strip\": true,\n \"flip\": true,\n \"show\": [],\n \"matrix\": true,\n \"ase\": true,\n \"simulate\": true,\n \"sample\": \"<string>\",\n \"roles\": true,\n \"glyphs\": true,\n \"embed\": true,\n \"kit\": true,\n \"ask\": true,\n \"collection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"search\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"query\": \"<string>\",\n \"limit\": 100,\n \"downloads\": true,\n \"from\": \"<string>\",\n \"depth\": 2,\n \"positions\": [],\n \"partner\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scales\": [\n 5.05\n ],\n \"form\": [\n {\n \"name\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"template\": \"<string>\",\n \"url\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n },\n \"after\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3000/api/v1/brands/{slug}/pages/{page}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"ops\": [\n {\n \"op\": \"add\",\n \"section\": {\n \"id\": \"<string>\",\n \"title\": \"<string>\",\n \"body\": \"<string>\",\n \"columns\": 2,\n \"hidden\": true,\n \"keys\": [\n \"<string>\"\n ],\n \"eyebrow\": \"<string>\",\n \"lede\": \"<string>\",\n \"aside\": \"<string>\",\n \"tab\": \"<string>\",\n \"background\": {\n \"color\": \"<string>\",\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scrim\": 0.45\n },\n \"items\": [\n {\n \"key\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"title\": \"<string>\",\n \"text\": \"<string>\",\n \"caption\": \"<string>\",\n \"link\": \"<string>\",\n \"label\": \"<string>\",\n \"icon\": \"<string>\",\n \"download\": true,\n \"span\": 1,\n \"at\": [\n 50,\n 50\n ],\n \"level\": 1\n }\n ],\n \"contexts\": [\n \"<string>\"\n ],\n \"only\": \"<string>\",\n \"translations\": {},\n \"props\": {\n \"image\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"video\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"strip\": true,\n \"flip\": true,\n \"show\": [],\n \"matrix\": true,\n \"ase\": true,\n \"simulate\": true,\n \"sample\": \"<string>\",\n \"roles\": true,\n \"glyphs\": true,\n \"embed\": true,\n \"kit\": true,\n \"ask\": true,\n \"collection\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"search\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"query\": \"<string>\",\n \"limit\": 100,\n \"downloads\": true,\n \"from\": \"<string>\",\n \"depth\": 2,\n \"positions\": [],\n \"partner\": \"<string>\",\n \"asset\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"scales\": [\n 5.05\n ],\n \"form\": [\n {\n \"name\": \"<string>\",\n \"label\": \"<string>\"\n }\n ],\n \"template\": \"<string>\",\n \"url\": \"<string>\",\n \"prompt\": \"<string>\"\n }\n },\n \"after\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"brand": "<string>",
"page": {
"slug": "<string>",
"title": "<string>",
"position": 0,
"hidden": true,
"parent": "<string>",
"eyebrow": "<string>",
"lede": "<string>",
"cover": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"icon": "<string>",
"audience": "everyone",
"tabs": true,
"aliases": [
"<string>"
],
"layout": "book",
"updatedAt": "2023-11-07T05:31:56Z",
"sections": [
{
"id": "<string>",
"template": "<string>",
"title": "<string>",
"body": "<string>",
"width": "text",
"columns": 0,
"tone": "<string>",
"hidden": true,
"keys": [
"<string>"
],
"props": {},
"eyebrow": "<string>",
"lede": "<string>",
"aside": "<string>",
"tab": "<string>",
"background": {
"color": "<string>",
"image": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"scrim": 123
},
"items": [
{
"key": "<string>",
"asset": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"text": "<string>",
"verdict": "do",
"caption": "<string>",
"link": "<string>",
"label": "<string>",
"icon": "<string>",
"download": true
}
],
"audience": "everyone",
"contexts": [
"<string>"
],
"only": "<string>",
"translations": {}
}
],
"translations": {}
},
"warnings": [
"<string>"
],
"url": "<string>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"detail": "<unknown>"
}
}Authorizations
bearersession
An API key: ab_...
Body
application/json
Applied in order; all or none
Required array length:
1 - 50 elements- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
Response
The page
Show child attributes
Show child attributes