Update the metadata in a space
PATCH
https://forumulate.com/api /orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata Writes the things around a page rather than its body — cover image, SEO, canonical URL, audience gate and the space type’s own declared fields. Honours If-Match, so a concurrent editor cannot be silently overwritten.
Requires token scope: write (the coarse method gate) for Atlas key (ak_), Personal Access Token (cft_) or OAuth (cfo_) auth — in addition to any catalog scope (GET /pats/scopes) the route’s capability needs. Session/cookie auth is governed by RBAC capabilities instead.
Parameters
orgIdstringpathrequiredspaceIdstringpathrequiredpageIdstringpathrequiredIf-MatchstringheaderThe tag you believe this resource is at: the
ETag header the matching read sets. It is opaque and changes on any change to the resource (body, title, slug, locale, metadata). The contentHash that read returned is also accepted and guards the content only — it does not move on a metadata edit. The write is applied only if the tag still holds, so two editors cannot overwrite each other unnoticed. A list is accepted and any member matching is enough; * asserts only that the resource exists. Omit it and the write is unconditional. On every other route a concrete value is a 428 rather than silently ignored.forumulate-versionstringheaderAPI version negotiation. Send
forumulate-version: 2026-12-01 on every request from a new integration; it is optional only so that integrations written before versioning keep working. Each version includes everything before it:Idempotency-KeystringheaderMakes this write safe to retry. Optional — send any unique string (a UUID is ideal) and the first request runs while its response is remembered under that key for 24 hours; an identical retry replays that same status and body instead of acting twice, so a timeout or a 5xx from the edge can be retried without creating a second row. A retry sent while the first request is still in flight is refused with
409. The key is scoped to the method and path, so the same key on a different endpoint is a different request. Error responses of 5xx are never cached — those retries re-run. A key is bound to the BODY it was first used with: reusing it with a different body is a 409 idempotency.key_reused, not a replay, because replaying would tell you a write landed that never ran. Generate one key per request, never per process or per session.Request body application/json
Example
{
"coverUrl": "https://cdn.forumulate.com/covers/getting-started.png",
"canonicalUrl": "https://docs.example.com/getting-started",
"layout": "wide",
"onThisPage": "always",
"shareImageUrl": "/api/assets/9b1f0c3e-launch-card",
"ogTitle": "Getting started in five minutes",
"twitterCard": "summary_large_image",
"customCss": ".forumulate-prose h2 { letter-spacing: -0.01em; }",
"theme": {
"primaryColor": "#0f766e",
"colorScheme": "light"
},
"audience": {
"claim": "plan",
"equals": "enterprise"
},
"fields": {
"owner": "platform-team",
"reviewedOn": "2026-09-01"
}
}Schema
tagsstring[]audienceobjectShow child parameters
claimstringequalsstringconditionstringfieldsobjectThe parameters this page’s space type declares. PATCH semantics: the keys you send are merged into the fields already stored, so sending one field leaves the rest alone, and
null clears a field. The declared keys, their labels, kinds and options are at GET /space-types/{TYPE} under fields — for a DOCS page they are audience (labelled "Written for"), appliesTo and deprecated. An undeclared key is refused with a 422 naming the keys that do exist.kindstringWhich kind of page this is, where the space type declares more than one (
pageKinds at GET /space-types/{TYPE}). A CAREERS page is a role (listed on the board, apply form, JobPosting markup) or a page (how you hire, culture: none of those). Absent means the type’s first kind; null clears it. A kind the type does not declare is a 422.iconPageIconName | stringAn icon name from
GET /icons?for=page (see the PageIconName enum), an emoji or short symbol (≤ 8 characters, no "/" or ":"), or an image URL. Any other bare word is refused: the reader would print it as text.hideFromNavbooleanexternalUrlstringnavTitlestringbadgeobjectShow child parameters
textstringrequiredvariantstringnavKindstringnavFontstringsearchExcludebooleanLeave this page out of the reader search and the site search. It is still published, linked and in the sitemap; use
noindex for search engines.coverUrlstringlayoutstringhideTitlebooleansubtitlestringhideUpdatedbooleanhideCoverbooleantemplatestringheroobjectShow child parameters
titlestringtaglinestringimagestringimageDarkstringimageAltstringactionsobject[]Show child parameters
textstringrequiredhrefstringrequiredvariantstringiconstringlayoutstringalignstringtitleSizenumber | stringalignPhonestringtocLevelsobjectShow child parameters
minintegerrequiredmaxintegerrequiredpageChromebooleantitleAlignstringthemePatchobjectA slice of the theme for THIS page only:
components (any block look) and docs.pageHead, docs.toc, docs.articleWidth, docs.pageActions, docs.api.titleSize. Merged over the space theme for this page; unknown keys are refused (422). Sent whole; null clears it.Show child parameters
componentsobjectShow child parameters
radiusnumbershadowstringfocusobjectcodeobjectinputobjectbuttonobjectspacingobjectselectionobjectscrollbarobjectsyntaxobjectsyntaxDarkobjectexpandableobjectcodeDarkobjectinputDarkobjectbuttonDarkobjectsyntaxThemestringlinkobjectmetaobjectimageobjectbylineobjectlistobjecthintobjectquoteobjectcaptionobjecttableobjectstepperobjectcardobjectkbdobjecttabsobjectpreviewobjectapiRefobjectpopoverobjectselectobjectskeletonobjectdocsobjectShow child parameters
pageHeadobjecttocobjectarticleWidthstringpageActionsobjectapiobjectblocksobjectonThisPagestringWhether THIS page carries the "on this page" rail:
auto (the surface default), always or never. Beats the space theme’s onThisPage; null or absent means the space decides.apiMethodstringapiPagestringapistringseoTitlestringseoDescriptionstringnoindexbooleancontentLanguagestringcanonicalUrlstringhideFeedbackbooleaneditUrlstring | booleansourcePathstringpagerobjectShow child parameters
prevstring | booleannextstring | booleanlabelstringhidePagerbooleankeywordsstring[]commentsEnabledbooleanfalse turns comments off on THIS page when the space takes comments; null/absent follows the space.
customCssstringCSS for THIS piece only, after the space theme so it wins. Sanitised and scoped to the reader exactly like the space
customCss (@import dropped, no way out of the <style>).themePageSetMetadataBodyThemeVariant1A partial theme for this piece — colours, palettes, fonts, typography, colorScheme, components, contentWidth, layout, motion, and (on a blog post)
post — layered over the space’s (which is over the site’s). On a post, release, event or legal document PATCH it MERGES key by key like the space theme’s PATCH, and null clears at any depth ({"paletteDark": null}); a page’s metadata replaces it whole. Unknown keys are refused by name. null clears all of it.Show child parameters
primaryColorstringaccentColorstringpaletteobjectShow child parameters
primarystringsecondarystringtertiarystringquaternarystringheader_backgroundstringheader_primarystringhighlightstringdangerstringsuccessstringlovestringbackgroundstringsurfacestringinkstringheadingstringmutedstringlinestringfooter_backgroundstringfooter_primarystringinfostringwarningstringtintbooleanpaperstringpaletteDarkobjectShow child parameters
primarystringsecondarystringtertiarystringquaternarystringheader_backgroundstringheader_primarystringhighlightstringdangerstringsuccessstringlovestringbackgroundstringsurfacestringinkstringheadingstringmutedstringlinestringfooter_backgroundstringfooter_primarystringinfostringwarningstringtintbooleanpaperstringfontstringcustomFontFamilystringheadingFontFamilystringbodyFontFamilystringmonoFontFamilystringcolorSchemestringcontentWidthstringlayoutobjectShow child parameters
measurestringframestringwidthsobjectguidesobjectindexHeaderstringgutternumber | string | objectbackgroundobjectcanvasstringheroDecorobjectfloatRoomstring | integercomponentsobjectShow child parameters
radiusnumbershadowstringfocusobjectcodeobjectinputobjectbuttonobjectspacingobjectselectionobjectscrollbarobjectsyntaxobjectsyntaxDarkobjectexpandableobjectcodeDarkobjectinputDarkobjectbuttonDarkobjectsyntaxThemestringlinkobjectmetaobjectimageobjectbylineobjectlistobjecthintobjectquoteobjectcaptionobjecttableobjectCode samples
cURL
curl -X PATCH "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata" \
-H "If-Match: <value>" \
-H "forumulate-version: <value>" \
-H "Idempotency-Key: <value>" \
-H "Content-Type: application/json" \
-d '{"tags":["string"],"audience":{"claim":"string","equals":"string","condition":"string"},"fields":{},"kind":"string","icon":"book","hideFromNav":true,"externalUrl":"string","navTitle":"string","badge":{"text":"string","variant":"default"},"navKind":"separator","navFont":"mono","searchExclude":true,"coverUrl":"string","layout":"narrow","hideTitle":true,"subtitle":"string","hideUpdated":true,"hideCover":true,"template":"doc","hero":{"title":"string","tagline":"string","image":"string","imageDark":"string","imageAlt":"string","actions":[null],"layout":"stack","align":"start","titleSize":null,"alignPhone":"start"},"tocLevels":{"min":0,"max":0},"pageChrome":true,"titleAlign":"start","themePatch":{"components":{"radius":0,"shadow":"none","focus":{"color":null,"width":null,"offset":null},"code":{"background":null,"ink":null,"border":null,"radius":null,"block":null,"inline":null,"look":null,"outer":null,"copy":null,"actions":null,"tabFont":null,"showLanguage":null,"tabStyle":null,"titleIcon":null,"titleFont":null,"wrap":null,"terminal":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"input":{"background":null,"ink":null,"border":null,"radius":null},"button":{"background":null,"ink":null,"border":null,"radius":null,"shadow":null,"weight":null,"edge":null},"spacing":{"scale":null,"block":null,"section":null,"pad":null},"selection":{"background":null,"ink":null},"scrollbar":{"width":null,"thumb":null,"track":null},"syntax":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"syntaxDark":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"expandable":{"style":null,"icon":null,"iconPosition":null,"border":null,"background":null,"ink":null,"borderDark":null,"backgroundDark":null,"inkDark":null,"radius":null,"pad":null},"codeDark":{"background":null,"ink":null,"border":null,"block":null,"inline":null,"outer":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"inputDark":{"background":null,"ink":null,"border":null},"buttonDark":{"background":null,"ink":null,"border":null},"syntaxTheme":"github","link":{"underline":null,"offset":null,"thickness":null,"weight":null,"color":null,"colorDark":null,"underlineColor":null,"underlineColorDark":null,"external":null},"meta":{"font":null,"case":null,"tracking":null,"scope":null,"size":null,"color":null,"colorDark":null},"image":{"radius":null,"margin":null,"backdrop":null},"byline":{"link":null},"list":{"marker":null,"markerColor":null,"markerColorDark":null,"itemGap":null,"hang":null},"hint":{"icon":null,"edge":null,"background":null,"backgroundDark":null,"border":null,"radius":null,"hang":null,"padding":null,"phone":null,"iconStyle":null,"hookRadius":null,"codeBackground":null,"codeBackgroundDark":null,"phoneBar":null,"variants":null},"quote":{"style":null,"size":null,"align":null},"caption":{"align":null},"table":{"rules":null,"stripe":null,"density":null,"headerBackground":null,"headerBackgroundDark":null,"headerInk":null,"headerInkDark":null,"size":null,"cellPadding":null,"border":null,"borderDark":null,"more":null,"codeInk":null,"codeInkDark":null,"wrap":null,"code":null},"stepper":{"marker":null,"line":null,"color":null,"colorDark":null,"zeroPad":null,"rule":null,"titleSize":null,"markerSize":null,"markerAlign":null,"badgePlacement":null},"card":{"arrow":null,"background":null,"backgroundDark":null,"iconAlign":null,"ctaPlacement":null,"border":null,"iconSize":null,"tileSize":null,"titleWeight":null,"titleSize":null,"descriptionSize":null,"minWidth":null,"divider":null,"iconBand":null,"gap":null},"kbd":{"background":null,"backgroundDark":null,"border":null,"borderDark":null,"ink":null,"inkDark":null,"radius":null,"font":null,"shadow":null},"tabs":{"overflow":null,"active":null,"style":null},"preview":{"border":null,"borderDark":null,"radius":null,"background":null,"backgroundDark":null},"apiRef":{"methodColors":null,"methodColorsDark":null,"methodStyle":null,"surface":null,"size":null,"card":null,"urlSize":null,"urlWeight":null,"urlTone":null},"popover":{"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"shadow":null,"blur":null},"select":{"style":null,"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"optionHover":null,"optionHoverDark":null,"optionSelected":null,"optionSelectedDark":null,"check":null},"skeleton":{"style":null,"radius":null,"baseColor":null,"baseColorDark":null,"highlightColor":null,"highlightColorDark":null,"firstPaint":null}},"docs":{"pageHead":{"description":null,"breadcrumb":null,"kicker":null,"kickerStyle":null,"updated":null,"updatedFormat":null,"date":null,"contributors":null,"rule":null,"ruleColor":null,"ruleColorDark":null,"titleGap":null,"icon":null},"toc":{"levels":null,"label":null,"labelCase":null,"labelSize":null,"labelFont":null,"labelColor":null,"labelColorDark":null,"labelIcon":null,"itemSize":null,"activeColor":null,"activeColorDark":null,"activeStyle":null,"steps":null,"extras":null,"extrasPlacement":null,"phone":null,"phonePlacement":null,"border":null,"borderColor":null,"borderColorDark":null,"extrasOnAside":null,"onHero":null},"articleWidth":null,"pageActions":{"placement":null,"style":null,"items":null,"primary":null,"phone":null,"phoneToc":null,"phoneIcon":null,"label":null},"api":{"titleSize":null},"blocks":{"prompt":null}}},"onThisPage":"auto","apiMethod":"GET","apiPage":"landing","api":"string","seoTitle":"string","seoDescription":"string","noindex":true,"contentLanguage":"string","canonicalUrl":"string","hideFeedback":true,"editUrl":"string","sourcePath":"string","pager":{"prev":null,"next":null,"label":"string"},"hidePager":true,"keywords":["string"],"commentsEnabled":true,"customCss":"string","theme":{"primaryColor":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"customFontFamily":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"colorScheme":null,"contentWidth":null,"layout":null,"components":null,"motion":null,"changelog":null,"typography":null,"post":null},"shareImageUrl":"string","ogTitle":"string","ogDescription":"string","twitterCard":"summary","jsonLd":"string"}'TypeScript
const res = await fetch('https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata', {
method: 'PATCH',
headers: {
'If-Match': '<value>',
'forumulate-version': '<value>',
'Idempotency-Key': '<value>',
'Content-Type': 'application/json',
},
body: JSON.stringify({"tags":["string"],"audience":{"claim":"string","equals":"string","condition":"string"},"fields":{},"kind":"string","icon":"book","hideFromNav":true,"externalUrl":"string","navTitle":"string","badge":{"text":"string","variant":"default"},"navKind":"separator","navFont":"mono","searchExclude":true,"coverUrl":"string","layout":"narrow","hideTitle":true,"subtitle":"string","hideUpdated":true,"hideCover":true,"template":"doc","hero":{"title":"string","tagline":"string","image":"string","imageDark":"string","imageAlt":"string","actions":[null],"layout":"stack","align":"start","titleSize":null,"alignPhone":"start"},"tocLevels":{"min":0,"max":0},"pageChrome":true,"titleAlign":"start","themePatch":{"components":{"radius":0,"shadow":"none","focus":{"color":null,"width":null,"offset":null},"code":{"background":null,"ink":null,"border":null,"radius":null,"block":null,"inline":null,"look":null,"outer":null,"copy":null,"actions":null,"tabFont":null,"showLanguage":null,"tabStyle":null,"titleIcon":null,"titleFont":null,"wrap":null,"terminal":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"input":{"background":null,"ink":null,"border":null,"radius":null},"button":{"background":null,"ink":null,"border":null,"radius":null,"shadow":null,"weight":null,"edge":null},"spacing":{"scale":null,"block":null,"section":null,"pad":null},"selection":{"background":null,"ink":null},"scrollbar":{"width":null,"thumb":null,"track":null},"syntax":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"syntaxDark":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"expandable":{"style":null,"icon":null,"iconPosition":null,"border":null,"background":null,"ink":null,"borderDark":null,"backgroundDark":null,"inkDark":null,"radius":null,"pad":null},"codeDark":{"background":null,"ink":null,"border":null,"block":null,"inline":null,"outer":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"inputDark":{"background":null,"ink":null,"border":null},"buttonDark":{"background":null,"ink":null,"border":null},"syntaxTheme":"github","link":{"underline":null,"offset":null,"thickness":null,"weight":null,"color":null,"colorDark":null,"underlineColor":null,"underlineColorDark":null,"external":null},"meta":{"font":null,"case":null,"tracking":null,"scope":null,"size":null,"color":null,"colorDark":null},"image":{"radius":null,"margin":null,"backdrop":null},"byline":{"link":null},"list":{"marker":null,"markerColor":null,"markerColorDark":null,"itemGap":null,"hang":null},"hint":{"icon":null,"edge":null,"background":null,"backgroundDark":null,"border":null,"radius":null,"hang":null,"padding":null,"phone":null,"iconStyle":null,"hookRadius":null,"codeBackground":null,"codeBackgroundDark":null,"phoneBar":null,"variants":null},"quote":{"style":null,"size":null,"align":null},"caption":{"align":null},"table":{"rules":null,"stripe":null,"density":null,"headerBackground":null,"headerBackgroundDark":null,"headerInk":null,"headerInkDark":null,"size":null,"cellPadding":null,"border":null,"borderDark":null,"more":null,"codeInk":null,"codeInkDark":null,"wrap":null,"code":null},"stepper":{"marker":null,"line":null,"color":null,"colorDark":null,"zeroPad":null,"rule":null,"titleSize":null,"markerSize":null,"markerAlign":null,"badgePlacement":null},"card":{"arrow":null,"background":null,"backgroundDark":null,"iconAlign":null,"ctaPlacement":null,"border":null,"iconSize":null,"tileSize":null,"titleWeight":null,"titleSize":null,"descriptionSize":null,"minWidth":null,"divider":null,"iconBand":null,"gap":null},"kbd":{"background":null,"backgroundDark":null,"border":null,"borderDark":null,"ink":null,"inkDark":null,"radius":null,"font":null,"shadow":null},"tabs":{"overflow":null,"active":null,"style":null},"preview":{"border":null,"borderDark":null,"radius":null,"background":null,"backgroundDark":null},"apiRef":{"methodColors":null,"methodColorsDark":null,"methodStyle":null,"surface":null,"size":null,"card":null,"urlSize":null,"urlWeight":null,"urlTone":null},"popover":{"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"shadow":null,"blur":null},"select":{"style":null,"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"optionHover":null,"optionHoverDark":null,"optionSelected":null,"optionSelectedDark":null,"check":null},"skeleton":{"style":null,"radius":null,"baseColor":null,"baseColorDark":null,"highlightColor":null,"highlightColorDark":null,"firstPaint":null}},"docs":{"pageHead":{"description":null,"breadcrumb":null,"kicker":null,"kickerStyle":null,"updated":null,"updatedFormat":null,"date":null,"contributors":null,"rule":null,"ruleColor":null,"ruleColorDark":null,"titleGap":null,"icon":null},"toc":{"levels":null,"label":null,"labelCase":null,"labelSize":null,"labelFont":null,"labelColor":null,"labelColorDark":null,"labelIcon":null,"itemSize":null,"activeColor":null,"activeColorDark":null,"activeStyle":null,"steps":null,"extras":null,"extrasPlacement":null,"phone":null,"phonePlacement":null,"border":null,"borderColor":null,"borderColorDark":null,"extrasOnAside":null,"onHero":null},"articleWidth":null,"pageActions":{"placement":null,"style":null,"items":null,"primary":null,"phone":null,"phoneToc":null,"phoneIcon":null,"label":null},"api":{"titleSize":null},"blocks":{"prompt":null}}},"onThisPage":"auto","apiMethod":"GET","apiPage":"landing","api":"string","seoTitle":"string","seoDescription":"string","noindex":true,"contentLanguage":"string","canonicalUrl":"string","hideFeedback":true,"editUrl":"string","sourcePath":"string","pager":{"prev":null,"next":null,"label":"string"},"hidePager":true,"keywords":["string"],"commentsEnabled":true,"customCss":"string","theme":{"primaryColor":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"customFontFamily":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"colorScheme":null,"contentWidth":null,"layout":null,"components":null,"motion":null,"changelog":null,"typography":null,"post":null},"shareImageUrl":"string","ogTitle":"string","ogDescription":"string","twitterCard":"summary","jsonLd":"string"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PATCH",
"https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata",
headers={
"If-Match": "<value>",
"forumulate-version": "<value>",
"Idempotency-Key": "<value>",
"Content-Type": "application/json",
},
json={"tags": ["string"], "audience": {"claim": "string", "equals": "string", "condition": "string"}, "fields": {}, "kind": "string", "icon": "book", "hideFromNav": True, "externalUrl": "string", "navTitle": "string", "badge": {"text": "string", "variant": "default"}, "navKind": "separator", "navFont": "mono", "searchExclude": True, "coverUrl": "string", "layout": "narrow", "hideTitle": True, "subtitle": "string", "hideUpdated": True, "hideCover": True, "template": "doc", "hero": {"title": "string", "tagline": "string", "image": "string", "imageDark": "string", "imageAlt": "string", "actions": [None], "layout": "stack", "align": "start", "titleSize": None, "alignPhone": "start"}, "tocLevels": {"min": 0, "max": 0}, "pageChrome": True, "titleAlign": "start", "themePatch": {"components": {"radius": 0, "shadow": "none", "focus": {"color": None, "width": None, "offset": None}, "code": {"background": None, "ink": None, "border": None, "radius": None, "block": None, "inline": None, "look": None, "outer": None, "copy": None, "actions": None, "tabFont": None, "showLanguage": None, "tabStyle": None, "titleIcon": None, "titleFont": None, "wrap": None, "terminal": None, "highlightBar": None, "highlightBackground": None, "insert": None, "delete": None}, "input": {"background": None, "ink": None, "border": None, "radius": None}, "button": {"background": None, "ink": None, "border": None, "radius": None, "shadow": None, "weight": None, "edge": None}, "spacing": {"scale": None, "block": None, "section": None, "pad": None}, "selection": {"background": None, "ink": None}, "scrollbar": {"width": None, "thumb": None, "track": None}, "syntax": {"comment": None, "keyword": None, "string": None, "number": None, "title": None, "built_in": None, "tag": None, "attr": None, "meta": None, "emphasis": None}, "syntaxDark": {"comment": None, "keyword": None, "string": None, "number": None, "title": None, "built_in": None, "tag": None, "attr": None, "meta": None, "emphasis": None}, "expandable": {"style": None, "icon": None, "iconPosition": None, "border": None, "background": None, "ink": None, "borderDark": None, "backgroundDark": None, "inkDark": None, "radius": None, "pad": None}, "codeDark": {"background": None, "ink": None, "border": None, "block": None, "inline": None, "outer": None, "highlightBar": None, "highlightBackground": None, "insert": None, "delete": None}, "inputDark": {"background": None, "ink": None, "border": None}, "buttonDark": {"background": None, "ink": None, "border": None}, "syntaxTheme": "github", "link": {"underline": None, "offset": None, "thickness": None, "weight": None, "color": None, "colorDark": None, "underlineColor": None, "underlineColorDark": None, "external": None}, "meta": {"font": None, "case": None, "tracking": None, "scope": None, "size": None, "color": None, "colorDark": None}, "image": {"radius": None, "margin": None, "backdrop": None}, "byline": {"link": None}, "list": {"marker": None, "markerColor": None, "markerColorDark": None, "itemGap": None, "hang": None}, "hint": {"icon": None, "edge": None, "background": None, "backgroundDark": None, "border": None, "radius": None, "hang": None, "padding": None, "phone": None, "iconStyle": None, "hookRadius": None, "codeBackground": None, "codeBackgroundDark": None, "phoneBar": None, "variants": None}, "quote": {"style": None, "size": None, "align": None}, "caption": {"align": None}, "table": {"rules": None, "stripe": None, "density": None, "headerBackground": None, "headerBackgroundDark": None, "headerInk": None, "headerInkDark": None, "size": None, "cellPadding": None, "border": None, "borderDark": None, "more": None, "codeInk": None, "codeInkDark": None, "wrap": None, "code": None}, "stepper": {"marker": None, "line": None, "color": None, "colorDark": None, "zeroPad": None, "rule": None, "titleSize": None, "markerSize": None, "markerAlign": None, "badgePlacement": None}, "card": {"arrow": None, "background": None, "backgroundDark": None, "iconAlign": None, "ctaPlacement": None, "border": None, "iconSize": None, "tileSize": None, "titleWeight": None, "titleSize": None, "descriptionSize": None, "minWidth": None, "divider": None, "iconBand": None, "gap": None}, "kbd": {"background": None, "backgroundDark": None, "border": None, "borderDark": None, "ink": None, "inkDark": None, "radius": None, "font": None, "shadow": None}, "tabs": {"overflow": None, "active": None, "style": None}, "preview": {"border": None, "borderDark": None, "radius": None, "background": None, "backgroundDark": None}, "apiRef": {"methodColors": None, "methodColorsDark": None, "methodStyle": None, "surface": None, "size": None, "card": None, "urlSize": None, "urlWeight": None, "urlTone": None}, "popover": {"background": None, "backgroundDark": None, "ink": None, "inkDark": None, "border": None, "borderDark": None, "radius": None, "shadow": None, "blur": None}, "select": {"style": None, "background": None, "backgroundDark": None, "ink": None, "inkDark": None, "border": None, "borderDark": None, "radius": None, "optionHover": None, "optionHoverDark": None, "optionSelected": None, "optionSelectedDark": None, "check": None}, "skeleton": {"style": None, "radius": None, "baseColor": None, "baseColorDark": None, "highlightColor": None, "highlightColorDark": None, "firstPaint": None}}, "docs": {"pageHead": {"description": None, "breadcrumb": None, "kicker": None, "kickerStyle": None, "updated": None, "updatedFormat": None, "date": None, "contributors": None, "rule": None, "ruleColor": None, "ruleColorDark": None, "titleGap": None, "icon": None}, "toc": {"levels": None, "label": None, "labelCase": None, "labelSize": None, "labelFont": None, "labelColor": None, "labelColorDark": None, "labelIcon": None, "itemSize": None, "activeColor": None, "activeColorDark": None, "activeStyle": None, "steps": None, "extras": None, "extrasPlacement": None, "phone": None, "phonePlacement": None, "border": None, "borderColor": None, "borderColorDark": None, "extrasOnAside": None, "onHero": None}, "articleWidth": None, "pageActions": {"placement": None, "style": None, "items": None, "primary": None, "phone": None, "phoneToc": None, "phoneIcon": None, "label": None}, "api": {"titleSize": None}, "blocks": {"prompt": None}}}, "onThisPage": "auto", "apiMethod": "GET", "apiPage": "landing", "api": "string", "seoTitle": "string", "seoDescription": "string", "noindex": True, "contentLanguage": "string", "canonicalUrl": "string", "hideFeedback": True, "editUrl": "string", "sourcePath": "string", "pager": {"prev": None, "next": None, "label": "string"}, "hidePager": True, "keywords": ["string"], "commentsEnabled": True, "customCss": "string", "theme": {"primaryColor": None, "accentColor": None, "palette": None, "paletteDark": None, "font": None, "customFontFamily": None, "headingFontFamily": None, "bodyFontFamily": None, "monoFontFamily": None, "colorScheme": None, "contentWidth": None, "layout": None, "components": None, "motion": None, "changelog": None, "typography": None, "post": None}, "shareImageUrl": "string", "ogTitle": "string", "ogDescription": "string", "twitterCard": "summary", "jsonLd": "string"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata", strings.NewReader(`{"tags":["string"],"audience":{"claim":"string","equals":"string","condition":"string"},"fields":{},"kind":"string","icon":"book","hideFromNav":true,"externalUrl":"string","navTitle":"string","badge":{"text":"string","variant":"default"},"navKind":"separator","navFont":"mono","searchExclude":true,"coverUrl":"string","layout":"narrow","hideTitle":true,"subtitle":"string","hideUpdated":true,"hideCover":true,"template":"doc","hero":{"title":"string","tagline":"string","image":"string","imageDark":"string","imageAlt":"string","actions":[null],"layout":"stack","align":"start","titleSize":null,"alignPhone":"start"},"tocLevels":{"min":0,"max":0},"pageChrome":true,"titleAlign":"start","themePatch":{"components":{"radius":0,"shadow":"none","focus":{"color":null,"width":null,"offset":null},"code":{"background":null,"ink":null,"border":null,"radius":null,"block":null,"inline":null,"look":null,"outer":null,"copy":null,"actions":null,"tabFont":null,"showLanguage":null,"tabStyle":null,"titleIcon":null,"titleFont":null,"wrap":null,"terminal":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"input":{"background":null,"ink":null,"border":null,"radius":null},"button":{"background":null,"ink":null,"border":null,"radius":null,"shadow":null,"weight":null,"edge":null},"spacing":{"scale":null,"block":null,"section":null,"pad":null},"selection":{"background":null,"ink":null},"scrollbar":{"width":null,"thumb":null,"track":null},"syntax":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"syntaxDark":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"expandable":{"style":null,"icon":null,"iconPosition":null,"border":null,"background":null,"ink":null,"borderDark":null,"backgroundDark":null,"inkDark":null,"radius":null,"pad":null},"codeDark":{"background":null,"ink":null,"border":null,"block":null,"inline":null,"outer":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"inputDark":{"background":null,"ink":null,"border":null},"buttonDark":{"background":null,"ink":null,"border":null},"syntaxTheme":"github","link":{"underline":null,"offset":null,"thickness":null,"weight":null,"color":null,"colorDark":null,"underlineColor":null,"underlineColorDark":null,"external":null},"meta":{"font":null,"case":null,"tracking":null,"scope":null,"size":null,"color":null,"colorDark":null},"image":{"radius":null,"margin":null,"backdrop":null},"byline":{"link":null},"list":{"marker":null,"markerColor":null,"markerColorDark":null,"itemGap":null,"hang":null},"hint":{"icon":null,"edge":null,"background":null,"backgroundDark":null,"border":null,"radius":null,"hang":null,"padding":null,"phone":null,"iconStyle":null,"hookRadius":null,"codeBackground":null,"codeBackgroundDark":null,"phoneBar":null,"variants":null},"quote":{"style":null,"size":null,"align":null},"caption":{"align":null},"table":{"rules":null,"stripe":null,"density":null,"headerBackground":null,"headerBackgroundDark":null,"headerInk":null,"headerInkDark":null,"size":null,"cellPadding":null,"border":null,"borderDark":null,"more":null,"codeInk":null,"codeInkDark":null,"wrap":null,"code":null},"stepper":{"marker":null,"line":null,"color":null,"colorDark":null,"zeroPad":null,"rule":null,"titleSize":null,"markerSize":null,"markerAlign":null,"badgePlacement":null},"card":{"arrow":null,"background":null,"backgroundDark":null,"iconAlign":null,"ctaPlacement":null,"border":null,"iconSize":null,"tileSize":null,"titleWeight":null,"titleSize":null,"descriptionSize":null,"minWidth":null,"divider":null,"iconBand":null,"gap":null},"kbd":{"background":null,"backgroundDark":null,"border":null,"borderDark":null,"ink":null,"inkDark":null,"radius":null,"font":null,"shadow":null},"tabs":{"overflow":null,"active":null,"style":null},"preview":{"border":null,"borderDark":null,"radius":null,"background":null,"backgroundDark":null},"apiRef":{"methodColors":null,"methodColorsDark":null,"methodStyle":null,"surface":null,"size":null,"card":null,"urlSize":null,"urlWeight":null,"urlTone":null},"popover":{"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"shadow":null,"blur":null},"select":{"style":null,"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"optionHover":null,"optionHoverDark":null,"optionSelected":null,"optionSelectedDark":null,"check":null},"skeleton":{"style":null,"radius":null,"baseColor":null,"baseColorDark":null,"highlightColor":null,"highlightColorDark":null,"firstPaint":null}},"docs":{"pageHead":{"description":null,"breadcrumb":null,"kicker":null,"kickerStyle":null,"updated":null,"updatedFormat":null,"date":null,"contributors":null,"rule":null,"ruleColor":null,"ruleColorDark":null,"titleGap":null,"icon":null},"toc":{"levels":null,"label":null,"labelCase":null,"labelSize":null,"labelFont":null,"labelColor":null,"labelColorDark":null,"labelIcon":null,"itemSize":null,"activeColor":null,"activeColorDark":null,"activeStyle":null,"steps":null,"extras":null,"extrasPlacement":null,"phone":null,"phonePlacement":null,"border":null,"borderColor":null,"borderColorDark":null,"extrasOnAside":null,"onHero":null},"articleWidth":null,"pageActions":{"placement":null,"style":null,"items":null,"primary":null,"phone":null,"phoneToc":null,"phoneIcon":null,"label":null},"api":{"titleSize":null},"blocks":{"prompt":null}}},"onThisPage":"auto","apiMethod":"GET","apiPage":"landing","api":"string","seoTitle":"string","seoDescription":"string","noindex":true,"contentLanguage":"string","canonicalUrl":"string","hideFeedback":true,"editUrl":"string","sourcePath":"string","pager":{"prev":null,"next":null,"label":"string"},"hidePager":true,"keywords":["string"],"commentsEnabled":true,"customCss":"string","theme":{"primaryColor":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"customFontFamily":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"colorScheme":null,"contentWidth":null,"layout":null,"components":null,"motion":null,"changelog":null,"typography":null,"post":null},"shareImageUrl":"string","ogTitle":"string","ogDescription":"string","twitterCard":"summary","jsonLd":"string"}`))
req.Header.Set("If-Match", "<value>")
req.Header.Set("forumulate-version", "<value>")
req.Header.Set("Idempotency-Key", "<value>")
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['If-Match: <value>', 'forumulate-version: <value>', 'Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"tags":["string"],"audience":{"claim":"string","equals":"string","condition":"string"},"fields":{},"kind":"string","icon":"book","hideFromNav":true,"externalUrl":"string","navTitle":"string","badge":{"text":"string","variant":"default"},"navKind":"separator","navFont":"mono","searchExclude":true,"coverUrl":"string","layout":"narrow","hideTitle":true,"subtitle":"string","hideUpdated":true,"hideCover":true,"template":"doc","hero":{"title":"string","tagline":"string","image":"string","imageDark":"string","imageAlt":"string","actions":[null],"layout":"stack","align":"start","titleSize":null,"alignPhone":"start"},"tocLevels":{"min":0,"max":0},"pageChrome":true,"titleAlign":"start","themePatch":{"components":{"radius":0,"shadow":"none","focus":{"color":null,"width":null,"offset":null},"code":{"background":null,"ink":null,"border":null,"radius":null,"block":null,"inline":null,"look":null,"outer":null,"copy":null,"actions":null,"tabFont":null,"showLanguage":null,"tabStyle":null,"titleIcon":null,"titleFont":null,"wrap":null,"terminal":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"input":{"background":null,"ink":null,"border":null,"radius":null},"button":{"background":null,"ink":null,"border":null,"radius":null,"shadow":null,"weight":null,"edge":null},"spacing":{"scale":null,"block":null,"section":null,"pad":null},"selection":{"background":null,"ink":null},"scrollbar":{"width":null,"thumb":null,"track":null},"syntax":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"syntaxDark":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"expandable":{"style":null,"icon":null,"iconPosition":null,"border":null,"background":null,"ink":null,"borderDark":null,"backgroundDark":null,"inkDark":null,"radius":null,"pad":null},"codeDark":{"background":null,"ink":null,"border":null,"block":null,"inline":null,"outer":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"inputDark":{"background":null,"ink":null,"border":null},"buttonDark":{"background":null,"ink":null,"border":null},"syntaxTheme":"github","link":{"underline":null,"offset":null,"thickness":null,"weight":null,"color":null,"colorDark":null,"underlineColor":null,"underlineColorDark":null,"external":null},"meta":{"font":null,"case":null,"tracking":null,"scope":null,"size":null,"color":null,"colorDark":null},"image":{"radius":null,"margin":null,"backdrop":null},"byline":{"link":null},"list":{"marker":null,"markerColor":null,"markerColorDark":null,"itemGap":null,"hang":null},"hint":{"icon":null,"edge":null,"background":null,"backgroundDark":null,"border":null,"radius":null,"hang":null,"padding":null,"phone":null,"iconStyle":null,"hookRadius":null,"codeBackground":null,"codeBackgroundDark":null,"phoneBar":null,"variants":null},"quote":{"style":null,"size":null,"align":null},"caption":{"align":null},"table":{"rules":null,"stripe":null,"density":null,"headerBackground":null,"headerBackgroundDark":null,"headerInk":null,"headerInkDark":null,"size":null,"cellPadding":null,"border":null,"borderDark":null,"more":null,"codeInk":null,"codeInkDark":null,"wrap":null,"code":null},"stepper":{"marker":null,"line":null,"color":null,"colorDark":null,"zeroPad":null,"rule":null,"titleSize":null,"markerSize":null,"markerAlign":null,"badgePlacement":null},"card":{"arrow":null,"background":null,"backgroundDark":null,"iconAlign":null,"ctaPlacement":null,"border":null,"iconSize":null,"tileSize":null,"titleWeight":null,"titleSize":null,"descriptionSize":null,"minWidth":null,"divider":null,"iconBand":null,"gap":null},"kbd":{"background":null,"backgroundDark":null,"border":null,"borderDark":null,"ink":null,"inkDark":null,"radius":null,"font":null,"shadow":null},"tabs":{"overflow":null,"active":null,"style":null},"preview":{"border":null,"borderDark":null,"radius":null,"background":null,"backgroundDark":null},"apiRef":{"methodColors":null,"methodColorsDark":null,"methodStyle":null,"surface":null,"size":null,"card":null,"urlSize":null,"urlWeight":null,"urlTone":null},"popover":{"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"shadow":null,"blur":null},"select":{"style":null,"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"optionHover":null,"optionHoverDark":null,"optionSelected":null,"optionSelectedDark":null,"check":null},"skeleton":{"style":null,"radius":null,"baseColor":null,"baseColorDark":null,"highlightColor":null,"highlightColorDark":null,"firstPaint":null}},"docs":{"pageHead":{"description":null,"breadcrumb":null,"kicker":null,"kickerStyle":null,"updated":null,"updatedFormat":null,"date":null,"contributors":null,"rule":null,"ruleColor":null,"ruleColorDark":null,"titleGap":null,"icon":null},"toc":{"levels":null,"label":null,"labelCase":null,"labelSize":null,"labelFont":null,"labelColor":null,"labelColorDark":null,"labelIcon":null,"itemSize":null,"activeColor":null,"activeColorDark":null,"activeStyle":null,"steps":null,"extras":null,"extrasPlacement":null,"phone":null,"phonePlacement":null,"border":null,"borderColor":null,"borderColorDark":null,"extrasOnAside":null,"onHero":null},"articleWidth":null,"pageActions":{"placement":null,"style":null,"items":null,"primary":null,"phone":null,"phoneToc":null,"phoneIcon":null,"label":null},"api":{"titleSize":null},"blocks":{"prompt":null}}},"onThisPage":"auto","apiMethod":"GET","apiPage":"landing","api":"string","seoTitle":"string","seoDescription":"string","noindex":true,"contentLanguage":"string","canonicalUrl":"string","hideFeedback":true,"editUrl":"string","sourcePath":"string","pager":{"prev":null,"next":null,"label":"string"},"hidePager":true,"keywords":["string"],"commentsEnabled":true,"customCss":"string","theme":{"primaryColor":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"customFontFamily":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"colorScheme":null,"contentWidth":null,"layout":null,"components":null,"motion":null,"changelog":null,"typography":null,"post":null},"shareImageUrl":"string","ogTitle":"string","ogDescription":"string","twitterCard":"summary","jsonLd":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata')
req = Net::HTTP::Patch.new(uri)
req['If-Match'] = '<value>'
req['forumulate-version'] = '<value>'
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"tags":["string"],"audience":{"claim":"string","equals":"string","condition":"string"},"fields":{},"kind":"string","icon":"book","hideFromNav":true,"externalUrl":"string","navTitle":"string","badge":{"text":"string","variant":"default"},"navKind":"separator","navFont":"mono","searchExclude":true,"coverUrl":"string","layout":"narrow","hideTitle":true,"subtitle":"string","hideUpdated":true,"hideCover":true,"template":"doc","hero":{"title":"string","tagline":"string","image":"string","imageDark":"string","imageAlt":"string","actions":[null],"layout":"stack","align":"start","titleSize":null,"alignPhone":"start"},"tocLevels":{"min":0,"max":0},"pageChrome":true,"titleAlign":"start","themePatch":{"components":{"radius":0,"shadow":"none","focus":{"color":null,"width":null,"offset":null},"code":{"background":null,"ink":null,"border":null,"radius":null,"block":null,"inline":null,"look":null,"outer":null,"copy":null,"actions":null,"tabFont":null,"showLanguage":null,"tabStyle":null,"titleIcon":null,"titleFont":null,"wrap":null,"terminal":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"input":{"background":null,"ink":null,"border":null,"radius":null},"button":{"background":null,"ink":null,"border":null,"radius":null,"shadow":null,"weight":null,"edge":null},"spacing":{"scale":null,"block":null,"section":null,"pad":null},"selection":{"background":null,"ink":null},"scrollbar":{"width":null,"thumb":null,"track":null},"syntax":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"syntaxDark":{"comment":null,"keyword":null,"string":null,"number":null,"title":null,"built_in":null,"tag":null,"attr":null,"meta":null,"emphasis":null},"expandable":{"style":null,"icon":null,"iconPosition":null,"border":null,"background":null,"ink":null,"borderDark":null,"backgroundDark":null,"inkDark":null,"radius":null,"pad":null},"codeDark":{"background":null,"ink":null,"border":null,"block":null,"inline":null,"outer":null,"highlightBar":null,"highlightBackground":null,"insert":null,"delete":null},"inputDark":{"background":null,"ink":null,"border":null},"buttonDark":{"background":null,"ink":null,"border":null},"syntaxTheme":"github","link":{"underline":null,"offset":null,"thickness":null,"weight":null,"color":null,"colorDark":null,"underlineColor":null,"underlineColorDark":null,"external":null},"meta":{"font":null,"case":null,"tracking":null,"scope":null,"size":null,"color":null,"colorDark":null},"image":{"radius":null,"margin":null,"backdrop":null},"byline":{"link":null},"list":{"marker":null,"markerColor":null,"markerColorDark":null,"itemGap":null,"hang":null},"hint":{"icon":null,"edge":null,"background":null,"backgroundDark":null,"border":null,"radius":null,"hang":null,"padding":null,"phone":null,"iconStyle":null,"hookRadius":null,"codeBackground":null,"codeBackgroundDark":null,"phoneBar":null,"variants":null},"quote":{"style":null,"size":null,"align":null},"caption":{"align":null},"table":{"rules":null,"stripe":null,"density":null,"headerBackground":null,"headerBackgroundDark":null,"headerInk":null,"headerInkDark":null,"size":null,"cellPadding":null,"border":null,"borderDark":null,"more":null,"codeInk":null,"codeInkDark":null,"wrap":null,"code":null},"stepper":{"marker":null,"line":null,"color":null,"colorDark":null,"zeroPad":null,"rule":null,"titleSize":null,"markerSize":null,"markerAlign":null,"badgePlacement":null},"card":{"arrow":null,"background":null,"backgroundDark":null,"iconAlign":null,"ctaPlacement":null,"border":null,"iconSize":null,"tileSize":null,"titleWeight":null,"titleSize":null,"descriptionSize":null,"minWidth":null,"divider":null,"iconBand":null,"gap":null},"kbd":{"background":null,"backgroundDark":null,"border":null,"borderDark":null,"ink":null,"inkDark":null,"radius":null,"font":null,"shadow":null},"tabs":{"overflow":null,"active":null,"style":null},"preview":{"border":null,"borderDark":null,"radius":null,"background":null,"backgroundDark":null},"apiRef":{"methodColors":null,"methodColorsDark":null,"methodStyle":null,"surface":null,"size":null,"card":null,"urlSize":null,"urlWeight":null,"urlTone":null},"popover":{"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"shadow":null,"blur":null},"select":{"style":null,"background":null,"backgroundDark":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"radius":null,"optionHover":null,"optionHoverDark":null,"optionSelected":null,"optionSelectedDark":null,"check":null},"skeleton":{"style":null,"radius":null,"baseColor":null,"baseColorDark":null,"highlightColor":null,"highlightColorDark":null,"firstPaint":null}},"docs":{"pageHead":{"description":null,"breadcrumb":null,"kicker":null,"kickerStyle":null,"updated":null,"updatedFormat":null,"date":null,"contributors":null,"rule":null,"ruleColor":null,"ruleColorDark":null,"titleGap":null,"icon":null},"toc":{"levels":null,"label":null,"labelCase":null,"labelSize":null,"labelFont":null,"labelColor":null,"labelColorDark":null,"labelIcon":null,"itemSize":null,"activeColor":null,"activeColorDark":null,"activeStyle":null,"steps":null,"extras":null,"extrasPlacement":null,"phone":null,"phonePlacement":null,"border":null,"borderColor":null,"borderColorDark":null,"extrasOnAside":null,"onHero":null},"articleWidth":null,"pageActions":{"placement":null,"style":null,"items":null,"primary":null,"phone":null,"phoneToc":null,"phoneIcon":null,"label":null},"api":{"titleSize":null},"blocks":{"prompt":null}}},"onThisPage":"auto","apiMethod":"GET","apiPage":"landing","api":"string","seoTitle":"string","seoDescription":"string","noindex":true,"contentLanguage":"string","canonicalUrl":"string","hideFeedback":true,"editUrl":"string","sourcePath":"string","pager":{"prev":null,"next":null,"label":"string"},"hidePager":true,"keywords":["string"],"commentsEnabled":true,"customCss":"string","theme":{"primaryColor":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"customFontFamily":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"colorScheme":null,"contentWidth":null,"layout":null,"components":null,"motion":null,"changelog":null,"typography":null,"post":null},"shareImageUrl":"string","ogTitle":"string","ogDescription":"string","twitterCard":"summary","jsonLd":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://forumulate.com/api/orgs/{orgId}/spaces/{spaceId}/pages/{pageId}/metadata"))
.header("If-Match", "<value>")
.header("forumulate-version", "<value>")
.header("Idempotency-Key", "<value>")
.header("Content-Type", "application/json")
.method("PATCH", BodyPublishers.ofString("{\"tags\":[\"string\"],\"audience\":{\"claim\":\"string\",\"equals\":\"string\",\"condition\":\"string\"},\"fields\":{},\"kind\":\"string\",\"icon\":\"book\",\"hideFromNav\":true,\"externalUrl\":\"string\",\"navTitle\":\"string\",\"badge\":{\"text\":\"string\",\"variant\":\"default\"},\"navKind\":\"separator\",\"navFont\":\"mono\",\"searchExclude\":true,\"coverUrl\":\"string\",\"layout\":\"narrow\",\"hideTitle\":true,\"subtitle\":\"string\",\"hideUpdated\":true,\"hideCover\":true,\"template\":\"doc\",\"hero\":{\"title\":\"string\",\"tagline\":\"string\",\"image\":\"string\",\"imageDark\":\"string\",\"imageAlt\":\"string\",\"actions\":[null],\"layout\":\"stack\",\"align\":\"start\",\"titleSize\":null,\"alignPhone\":\"start\"},\"tocLevels\":{\"min\":0,\"max\":0},\"pageChrome\":true,\"titleAlign\":\"start\",\"themePatch\":{\"components\":{\"radius\":0,\"shadow\":\"none\",\"focus\":{\"color\":null,\"width\":null,\"offset\":null},\"code\":{\"background\":null,\"ink\":null,\"border\":null,\"radius\":null,\"block\":null,\"inline\":null,\"look\":null,\"outer\":null,\"copy\":null,\"actions\":null,\"tabFont\":null,\"showLanguage\":null,\"tabStyle\":null,\"titleIcon\":null,\"titleFont\":null,\"wrap\":null,\"terminal\":null,\"highlightBar\":null,\"highlightBackground\":null,\"insert\":null,\"delete\":null},\"input\":{\"background\":null,\"ink\":null,\"border\":null,\"radius\":null},\"button\":{\"background\":null,\"ink\":null,\"border\":null,\"radius\":null,\"shadow\":null,\"weight\":null,\"edge\":null},\"spacing\":{\"scale\":null,\"block\":null,\"section\":null,\"pad\":null},\"selection\":{\"background\":null,\"ink\":null},\"scrollbar\":{\"width\":null,\"thumb\":null,\"track\":null},\"syntax\":{\"comment\":null,\"keyword\":null,\"string\":null,\"number\":null,\"title\":null,\"built_in\":null,\"tag\":null,\"attr\":null,\"meta\":null,\"emphasis\":null},\"syntaxDark\":{\"comment\":null,\"keyword\":null,\"string\":null,\"number\":null,\"title\":null,\"built_in\":null,\"tag\":null,\"attr\":null,\"meta\":null,\"emphasis\":null},\"expandable\":{\"style\":null,\"icon\":null,\"iconPosition\":null,\"border\":null,\"background\":null,\"ink\":null,\"borderDark\":null,\"backgroundDark\":null,\"inkDark\":null,\"radius\":null,\"pad\":null},\"codeDark\":{\"background\":null,\"ink\":null,\"border\":null,\"block\":null,\"inline\":null,\"outer\":null,\"highlightBar\":null,\"highlightBackground\":null,\"insert\":null,\"delete\":null},\"inputDark\":{\"background\":null,\"ink\":null,\"border\":null},\"buttonDark\":{\"background\":null,\"ink\":null,\"border\":null},\"syntaxTheme\":\"github\",\"link\":{\"underline\":null,\"offset\":null,\"thickness\":null,\"weight\":null,\"color\":null,\"colorDark\":null,\"underlineColor\":null,\"underlineColorDark\":null,\"external\":null},\"meta\":{\"font\":null,\"case\":null,\"tracking\":null,\"scope\":null,\"size\":null,\"color\":null,\"colorDark\":null},\"image\":{\"radius\":null,\"margin\":null,\"backdrop\":null},\"byline\":{\"link\":null},\"list\":{\"marker\":null,\"markerColor\":null,\"markerColorDark\":null,\"itemGap\":null,\"hang\":null},\"hint\":{\"icon\":null,\"edge\":null,\"background\":null,\"backgroundDark\":null,\"border\":null,\"radius\":null,\"hang\":null,\"padding\":null,\"phone\":null,\"iconStyle\":null,\"hookRadius\":null,\"codeBackground\":null,\"codeBackgroundDark\":null,\"phoneBar\":null,\"variants\":null},\"quote\":{\"style\":null,\"size\":null,\"align\":null},\"caption\":{\"align\":null},\"table\":{\"rules\":null,\"stripe\":null,\"density\":null,\"headerBackground\":null,\"headerBackgroundDark\":null,\"headerInk\":null,\"headerInkDark\":null,\"size\":null,\"cellPadding\":null,\"border\":null,\"borderDark\":null,\"more\":null,\"codeInk\":null,\"codeInkDark\":null,\"wrap\":null,\"code\":null},\"stepper\":{\"marker\":null,\"line\":null,\"color\":null,\"colorDark\":null,\"zeroPad\":null,\"rule\":null,\"titleSize\":null,\"markerSize\":null,\"markerAlign\":null,\"badgePlacement\":null},\"card\":{\"arrow\":null,\"background\":null,\"backgroundDark\":null,\"iconAlign\":null,\"ctaPlacement\":null,\"border\":null,\"iconSize\":null,\"tileSize\":null,\"titleWeight\":null,\"titleSize\":null,\"descriptionSize\":null,\"minWidth\":null,\"divider\":null,\"iconBand\":null,\"gap\":null},\"kbd\":{\"background\":null,\"backgroundDark\":null,\"border\":null,\"borderDark\":null,\"ink\":null,\"inkDark\":null,\"radius\":null,\"font\":null,\"shadow\":null},\"tabs\":{\"overflow\":null,\"active\":null,\"style\":null},\"preview\":{\"border\":null,\"borderDark\":null,\"radius\":null,\"background\":null,\"backgroundDark\":null},\"apiRef\":{\"methodColors\":null,\"methodColorsDark\":null,\"methodStyle\":null,\"surface\":null,\"size\":null,\"card\":null,\"urlSize\":null,\"urlWeight\":null,\"urlTone\":null},\"popover\":{\"background\":null,\"backgroundDark\":null,\"ink\":null,\"inkDark\":null,\"border\":null,\"borderDark\":null,\"radius\":null,\"shadow\":null,\"blur\":null},\"select\":{\"style\":null,\"background\":null,\"backgroundDark\":null,\"ink\":null,\"inkDark\":null,\"border\":null,\"borderDark\":null,\"radius\":null,\"optionHover\":null,\"optionHoverDark\":null,\"optionSelected\":null,\"optionSelectedDark\":null,\"check\":null},\"skeleton\":{\"style\":null,\"radius\":null,\"baseColor\":null,\"baseColorDark\":null,\"highlightColor\":null,\"highlightColorDark\":null,\"firstPaint\":null}},\"docs\":{\"pageHead\":{\"description\":null,\"breadcrumb\":null,\"kicker\":null,\"kickerStyle\":null,\"updated\":null,\"updatedFormat\":null,\"date\":null,\"contributors\":null,\"rule\":null,\"ruleColor\":null,\"ruleColorDark\":null,\"titleGap\":null,\"icon\":null},\"toc\":{\"levels\":null,\"label\":null,\"labelCase\":null,\"labelSize\":null,\"labelFont\":null,\"labelColor\":null,\"labelColorDark\":null,\"labelIcon\":null,\"itemSize\":null,\"activeColor\":null,\"activeColorDark\":null,\"activeStyle\":null,\"steps\":null,\"extras\":null,\"extrasPlacement\":null,\"phone\":null,\"phonePlacement\":null,\"border\":null,\"borderColor\":null,\"borderColorDark\":null,\"extrasOnAside\":null,\"onHero\":null},\"articleWidth\":null,\"pageActions\":{\"placement\":null,\"style\":null,\"items\":null,\"primary\":null,\"phone\":null,\"phoneToc\":null,\"phoneIcon\":null,\"label\":null},\"api\":{\"titleSize\":null},\"blocks\":{\"prompt\":null}}},\"onThisPage\":\"auto\",\"apiMethod\":\"GET\",\"apiPage\":\"landing\",\"api\":\"string\",\"seoTitle\":\"string\",\"seoDescription\":\"string\",\"noindex\":true,\"contentLanguage\":\"string\",\"canonicalUrl\":\"string\",\"hideFeedback\":true,\"editUrl\":\"string\",\"sourcePath\":\"string\",\"pager\":{\"prev\":null,\"next\":null,\"label\":\"string\"},\"hidePager\":true,\"keywords\":[\"string\"],\"commentsEnabled\":true,\"customCss\":\"string\",\"theme\":{\"primaryColor\":null,\"accentColor\":null,\"palette\":null,\"paletteDark\":null,\"font\":null,\"customFontFamily\":null,\"headingFontFamily\":null,\"bodyFontFamily\":null,\"monoFontFamily\":null,\"colorScheme\":null,\"contentWidth\":null,\"layout\":null,\"components\":null,\"motion\":null,\"changelog\":null,\"typography\":null,\"post\":null},\"shareImageUrl\":\"string\",\"ogTitle\":\"string\",\"ogDescription\":\"string\",\"twitterCard\":\"summary\",\"jsonLd\":\"string\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 The merged metadata.
{
"metadata": {},
"warnings": [
"tags: \"Launch Day\" is stored as \"launch-day\""
]
}400 The request could not be understood — a malformed header, path or query value (
request.malformed). A value that was understood but is not acceptable is a 422 validation.failed.{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}401 No credential, or one that is expired or revoked (
auth.required). Send a Bearer token or the session cookie.{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}403 Authenticated, and not allowed — always
rbac.forbidden, whether what is missing is the capability, the token scope, or a resource the token is pinned away from. The message names the capability and, for a scope refusal, the scopes that would grant it. A refusal because of the PLAN is a 402 with quota.exceeded, not this.{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}404 No such thing — one of the ids in the path does not resolve, or resolves to something this caller may not see (
*.not_found).{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}412 The precondition no longer holds: the resource changed after the tag you sent. Nothing was written. Re-read it, merge, and retry — the body names both tags (
precondition.failed).{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}422 The body was understood and a value is unacceptable (
validation.failed). error.details names the field paths.{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}429 Rate limited — see the RateLimit-* headers.
{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}default Error — the stable { error: { code, message } } envelope.
{
"error": {
"code": "string",
"message": "string",
"details": {},
"docs": "string",
"reason": "string",
"slugs": [
"string"
],
"conflict": {
"etag": "string",
"ops": [
null
]
}
},
"requestId": "string"
}The Forumulate teamUpdated