Documentation IndexFetch the complete documentation index at: /llms.txtUse this file to discover all available pages before exploring further.
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Update a page.
cURL
curl --request PATCH \ --url https://api.useinvent.com/orgs/pages/{page_ref} \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "title": "Store overview", "slug": "store-overview", "icon": "<string>", "parent_id": "<string>", "show_in_sidebar": true, "archived": true, "readonly": true } '
import requests url = "https://api.useinvent.com/orgs/pages/{page_ref}" payload = { "title": "Store overview", "slug": "store-overview", "icon": "<string>", "parent_id": "<string>", "show_in_sidebar": True, "archived": True, "readonly": True } 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({ title: 'Store overview', slug: 'store-overview', icon: '<string>', parent_id: '<string>', show_in_sidebar: true, archived: true, readonly: true }) }; fetch('https://api.useinvent.com/orgs/pages/{page_ref}', 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.useinvent.com/orgs/pages/{page_ref}", 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([ 'title' => 'Store overview', 'slug' => 'store-overview', 'icon' => '<string>', 'parent_id' => '<string>', 'show_in_sidebar' => true, 'archived' => true, 'readonly' => true ]), 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 := "https://api.useinvent.com/orgs/pages/{page_ref}" payload := strings.NewReader("{\n \"title\": \"Store overview\",\n \"slug\": \"store-overview\",\n \"icon\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"show_in_sidebar\": true,\n \"archived\": true,\n \"readonly\": true\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("https://api.useinvent.com/orgs/pages/{page_ref}") .header("Authorization", "Bearer <token>") .header("Content-Type", "application/json") .body("{\n \"title\": \"Store overview\",\n \"slug\": \"store-overview\",\n \"icon\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"show_in_sidebar\": true,\n \"archived\": true,\n \"readonly\": true\n}") .asString();
require 'uri' require 'net/http' url = URI("https://api.useinvent.com/orgs/pages/{page_ref}") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Patch.new(url) request["Authorization"] = 'Bearer <token>' request["Content-Type"] = 'application/json' request.body = "{\n \"title\": \"Store overview\",\n \"slug\": \"store-overview\",\n \"icon\": \"<string>\",\n \"parent_id\": \"<string>\",\n \"show_in_sidebar\": true,\n \"archived\": true,\n \"readonly\": true\n}" response = http.request(request) puts response.read_body
{ "id": "page_5Fb7…", "slug": "store-overview", "title": "Store overview", "icon": "<string>", "color": "red", "parent_id": "<string>", "position": 123, "show_in_sidebar": true, "archived": true, "readonly": true, "created_at": "2023-11-07T05:31:56Z", "updated_at": "2023-11-07T05:31:56Z" }
Bearer token authentication using your API key
Page slug or encoded page id
Page title.
1 - 255
"Store overview"
New friendly URL segment (kebab-case), unique per org.
1 - 64
^[a-z][a-z0-9-]{0,63}$
"store-overview"
The emoji of a curated icon a user can pick for a table, view, field, or other entity
Accent color, by name
red
orange
amber
yellow
lime
green
teal
cyan
sky
blue
indigo
violet
purple
fuchsia
pink
rose
neutral
Parent page id or slug. Reserved for nesting.
128
Whether the page appears in the sidebar.
Whether the page is archived, which hides it from the page list.
"page_5Fb7…"
Friendly URL segment, unique per org.
Parent page id. Reserved for nesting; unused by the UI.
Sidebar-zone order.
Locked: the UI hides all edit affordances until unlocked.
Was this page helpful?