Update the site
PATCH
https://forumulate.com/api /orgs/{orgId}/sites/{siteId} Deep-merges into the stored configuration, so renaming the call-to-action cannot discard the theme beside it. Nested objects combine, ordered lists and plain values replace, and an explicit null erases a key — the same rules the space theme patch follows. Add ?dryRun=true to see the key-by-key diff without writing.
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
orgIdstringpathrequiredsiteIdstringpathrequireddryRunstringqueryUse true or false (true/1/yes/on and false/0/no/off are accepted).
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
namestringspaceIdsstring[]configobjectDEEP-MERGED onto the stored config: nested objects merge, arrays and scalars replace. A key you leave out is KEPT — send it as
null to delete it ({"footer":{"art":null}}), or use PUT to replace the whole config. Header and footer keys (cta, headerLinks, footerColumns, footer, socialLinks, …) sit at the TOP of config, never under config.theme.chrome (a 422). Inside a site, the site’s chrome and config.theme.whiteLabel win over each member space’s own. ?dryRun=true answers the diff and writes nothing.Show child parameters
ctaobjectShow child parameters
labelstringhrefstringaudiencestringbackgroundstringinkstringsizestringshowOnPhonebooleanborderstringheightintegerfontSizenumbericonHeaderIconName | stringAn icon name from
GET /icons?for=header (see the HeaderIconName enum: our glyphs, the extended set and the brand marks), or an image URL (https://…, /api/assets/…, or a data: PNG/JPEG/WebP/GIF — not SVG). Any other bare word is refused.phonestringinkDarkstringborderDarkstringsecondaryCtaobjectShow child parameters
labelstringhrefstringaudiencestringstylestringinkstringbackgroundstringunderlinebooleansizestringborderstringshowOnPhonebooleanheightintegerfontSizenumberphonestringinkDarkstringborderDarkstringheaderobjectShow child parameters
overlaybooleanoverlayInkstringheightinteger | objectborderstring | objectborderColorstringshadowstringblurintegeropacitynumberlogoHeightinteger | objecticonSizenumber | objectnavGapintegernavWeightintegernavSizenumbernavCasestringnavTrackingnumbernavInkstringnavInkDarkstringnavFontstringlinksAlignstringmaxLinksintegercontrolsAlignstringscrollTitleboolean | stringscrollTitleFontstringbrandSizenumber | objectbrandPrefixobjectmenuButtonobjectpaintstringorderstring[]accentTopobjectctaDividerbooleangroupobjectborderSpanstringgroupOnScrollstringphoneLayoutstringnavSeparatorstringfloatingobjectbackgroundobjectactiveStylestringactiveMatchstringsectionCrumbbooleansectionCrumbSeparatorstringlogoHrefstringheaderLinksSpaceSettingsSetThemeBodyChromeHeaderLinksItem[]Show child parameters
labelstringrequiredhrefstringchildrenSpaceSettingsSetThemeBodyItemChildrenItem[]panelobjectstylestringhighlightbooleandividerbooleaniconHeaderIconName | stringAn icon name from
GET /icons?for=header (see the HeaderIconName enum: our glyphs, the extended set and the brand marks), or an image URL (https://…, /api/assets/…, or a data: PNG/JPEG/WebP/GIF — not SVG). Any other bare word is refused.iconDarkHeaderIconName | stringAn icon name from
GET /icons?for=header (see the HeaderIconName enum: our glyphs, the extended set and the brand marks), or an image URL (https://…, /api/assets/…, or a data: PNG/JPEG/WebP/GIF — not SVG). Any other bare word is refused.iconOnlybooleangithubRepostringmatchobjectphonestringplacementstringkbdstringinkstringinkDarkstringborderstringborderDarkstringaudiencestringnavMenuobjectShow child parameters
triggerstringopenDelayintegercloseDelayintegeranimationstringradiusnumbershadowstringbackgroundstringinkstringborderstringwidthintegerfooterLinksobject[]Show child parameters
labelstringhrefstringaudiencestringfooterDescriptionstringfooterColumnsobject[]Show child parameters
headingstringlinksobject[]stackbooleanaudiencestringsocialLinksobject[]Show child parameters
platformstringhrefstringcopyrightstringfooterobjectShow child parameters
logostring | booleanlogoMarkstring | booleancookieLinkPlacementstringhtmlstringcssstringhtmlPlacementstringnewsletterobjectschemestringheadingStylestringheadingInkstringheadingInkDarkstringheadingFontstringheadingSizenumberheadingGapnumbercolumnRulebooleanhideOnstring[]headingWeightintegerbottomAlignstringwidthstringcontentWidthstringfontstringshowBrandNamebooleanbrandPlacementstringbrandWidthnumber | stringcolumnWidthnumberpaddingobjectbottomSizenumberhtmlSizenumberhtmlLinkInkstringhtmlLinkInkDarkstringhtmlLinkUnderlinebooleanborderbooleanbottomRulebooleanlinkSizenumberlinkGapnumberlinkInkstringlinkInkDarkstringlinkWeightintegerlayoutstringlinkSeparatorstringsocialStylestringsocialSizeintegerbreadcrumbbooleanbreadcrumbPlacementstringphonestringartSpaceSettingsSetThemeBodyChromeFooterArtstatusobjectcolumnsinteger | stringbackgroundobjectmobileNavstringstickybooleanheightstringalignstringctaStylestringshowSignInbooleanthemeToggleobjectShow child parameters
showbooleanstylestringmodesstring[]borderbooleanhideOnstring[]phonestringpositionstringfooterAlignstringradiusnumberactiveColorstringsidebarBrandstringbrandTextstring | objectlogoPhonestringaccountMenuobjectShow child parameters
itemsstring | object[]showNamebooleanshowAvatarbooleanbellbooleantranslationsobjectctasobject[]{
"name": "string",
"spaceIds": [
"string"
],
"config": {
"cta": {
"label": null,
"href": null,
"audience": null,
"background": null,
"ink": null,
"size": null,
"showOnPhone": null,
"border": null,
"height": null,
"fontSize": null,
"icon": null,
"phone": null,
"inkDark": null,
"borderDark": null
},
"secondaryCta": {
"label": null,
"href": null,
"audience": null,
"style": null,
"ink": null,
"background": null,
"underline": null,
"size": null,
"border": null,
"showOnPhone": null,
"height": null,
"fontSize": null,
"phone": null,
"inkDark": null,
"borderDark": null
},
"header": {
"overlay": null,
"overlayInk": null,
"height": null,
"border": null,
"borderColor": null,
"shadow": null,
"blur": null,
"opacity": null,
"logoHeight": null,
"iconSize": null,
"navGap": null,
"navWeight": null,
"navSize": null,
"navCase": null,
"navTracking": null,
"navInk": null,
"navInkDark": null,
"navFont": null,
"linksAlign": null,
"maxLinks": null,
"controlsAlign": null,
"scrollTitle": null,
"scrollTitleFont": null,
"brandSize": null,
"brandPrefix": null,
"menuButton": null,
"paint": null,
"order": null,
"accentTop": null,
"ctaDivider": null,
"group": null,
"borderSpan": null,
"groupOnScroll": null,
"phoneLayout": null,
"navSeparator": null,
"floating": null,
"background": null,
"activeStyle": null,
"activeMatch": null,
"sectionCrumb": null,
"sectionCrumbSeparator": null,
"logoHref": null
},
"headerLinks": [
{
"label": null,
"href": null,
"children": null,
"panel": null,
"style": null,
"highlight": null,
"divider": null,
"icon": null,
"iconDark": null,
"iconOnly": null,
"githubRepo": null,
"match": null,
"phone": null,
"placement": null,
"kbd": null,
"ink": null,
"inkDark": null,
"border": null,
"borderDark": null,
"audience": null
}
],
"navMenu": {
"trigger": null,
"openDelay": null,
"closeDelay": null,
"animation": null,
"radius": null,
"shadow": null,
"background": null,
"ink": null,
"border": null,
"width": null
},
"footerLinks": [
{
"label": null,
"href": null,
"audience": null
}
],
"footerDescription": "string",
"footerColumns": [
{
"heading": null,
"links": null,
"stack": null,
"audience": null
}
],
"socialLinks": [
{
"platform": null,
"href": null
}
],
"copyright": "string",
"footer": {
"logo": null,
"logoMark": null,
"cookieLinkPlacement": null,
"html": null,
"css": null,
"htmlPlacement": null,
"newsletter": null,
"scheme": null,
"headingStyle": null,
"headingInk": null,
"headingInkDark": null,
"headingFont": null,
"headingSize": null,
"headingGap": null,
"columnRule": null,
"hideOn": null,
"headingWeight": null,
"bottomAlign": null,
"width": null,
"contentWidth": null,
"font": null,
"showBrandName": null,
"brandPlacement": null,
"brandWidth": null,
"columnWidth": null,
"padding": null,
"bottomSize": null,
"htmlSize": null,
"htmlLinkInk": null,
"htmlLinkInkDark": null,
"htmlLinkUnderline": null,
"border": null,
"bottomRule": null,
"linkSize": null,
"linkGap": null,
"linkInk": null,
"linkInkDark": null,
"linkWeight": null,
"layout": null,
"linkSeparator": null,
"socialStyle": null,
"socialSize": null,
"breadcrumb": null,
"breadcrumbPlacement": null,
"phone": null,
"art": null,
"status": null,
"columns": null,
"background": null
},
"mobileNav": "menu",
"sticky": true,
"height": "compact",
"align": "split",
"ctaStyle": "solid",
"showSignIn": true,
"themeToggle": {
"show": null,
"style": null,
"modes": null,
"border": null,
"hideOn": null,
"phone": null,
"position": null,
"footerAlign": null,
"radius": null,
"activeColor": null
},
"sidebarBrand": "show",
"brandText": "auto",
"logoPhone": "full",
"accountMenu": {
"items": null,
"showName": null,
"showAvatar": null,
"bell": null
},
"translations": {},
"ctas": [
{
"label": null,
"href": null,
"audience": null,
"style": null,
"background": null,
"ink": null,
"underline": null,
"size": null,
"border": null,
"showOnPhone": null,
"height": null,
"fontSize": null,
"icon": null,
"action": null,
"phone": null,
"inkDark": null,
"borderDark": null
}
],
"topBar": {
"links": null,
"background": null,
"ink": null,
"height": null,
"align": null,
"style": null,
"phone": null,
"button": null,
"sticky": null,
"font": null,
"case": null,
"tracking": null
},
"subnav": {
"links": null,
"navSize": null,
"navWeight": null,
"phone": null,
"justify": null,
"background": null,
"ink": null,
"border": null,
"backgroundDark": null,
"inkDark": null,
"active": null,
"endLinks": null
},
"search": "none",
"searchPlacement": "start",
"searchHideOn": [
"desktop"
],
"searchStyle": {
"label": null,
"background": null,
"ink": null,
"backgroundDark": null,
"inkDark": null,
"size": null,
"glyph": null,
"labelPhone": null,
"width": null,
"kbd": null,
"open": null,
"kbdStyle": null,
"shrink": null,
"iconFrame": null
},
"desktopNav": "inline",
"signInStyle": {
"look": null,
"icon": null,
"label": null,
"order": null,
"phone": null
},
"sidebarToggle": true,
"tagline": "string",
"tabs": [
{
"title": null,
"slug": null,
"spaceIds": null
}
],
"headerSpaceIds": [
"string"
],
"theme": {
"primaryColor": null,
"primaryColorDark": null,
"accentColor": null,
"palette": null,
"paletteDark": null,
"font": null,
"colorScheme": null,
"colorSchemeStrict": null,
"contentWidth": null,
"onThisPage": null,
"layout": null,
"customFontUrl": null,
"customFontFamily": null,
"brandName": null,
"logoIncludesName": null,
"headingFontFamily": null,
"bodyFontFamily": null,
"monoFontFamily": null,
"typography": null,
"headingAnchors": null,
"fonts": null,
"logoUrl": null,
"logoMark": null,
"logoUrlLight": null,
"logoUrlDark": null,
"logoDarkMode": null,
"faviconUrl": null,
"customCss": null,
"customJs": null,
"scriptOrigins": null,
"ads": null,
"whiteLabel": null,
"showLanguageSwitcher": null,
"apiOrigins": null,
"fontOrigins": null,
"fontOriginsRemoved": null,
"imgOrigins": null,
"mediaOrigins": null,
"frameOrigins": null,
"elementStyles": null,
"settingsSchema": null,
"settings": null,
"stringOverrides": null,
"cssSnippets": null,
"announcement": null,
"chrome": null,
"notFound": null,
"components": null,
"changelog": null,
"forum": null,
"post": null,
"docs": null,
"footnotes": null,
"i18n": null,
"status": null,
"legal": null,
"faq": null,
"roadmap": null,
"events": null,
"courses": null,
"careers": null,
"contact": null,
"motion": null,
"titleBand": null,
"componentInstalls": null,
"mobile": null
},
"pageMounts": [
{
"path": null,
"spaceId": null,
"page": null
}
]
}
}Code samples
cURL
curl -X PATCH "https://forumulate.com/api/orgs/{orgId}/sites/{siteId}?dryRun=" \
-H "forumulate-version: <value>" \
-H "Idempotency-Key: <value>" \
-H "Content-Type: application/json" \
-d '{"name":"string","spaceIds":["string"],"config":{"cta":{"label":null,"href":null,"audience":null,"background":null,"ink":null,"size":null,"showOnPhone":null,"border":null,"height":null,"fontSize":null,"icon":null,"phone":null,"inkDark":null,"borderDark":null},"secondaryCta":{"label":null,"href":null,"audience":null,"style":null,"ink":null,"background":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"phone":null,"inkDark":null,"borderDark":null},"header":{"overlay":null,"overlayInk":null,"height":null,"border":null,"borderColor":null,"shadow":null,"blur":null,"opacity":null,"logoHeight":null,"iconSize":null,"navGap":null,"navWeight":null,"navSize":null,"navCase":null,"navTracking":null,"navInk":null,"navInkDark":null,"navFont":null,"linksAlign":null,"maxLinks":null,"controlsAlign":null,"scrollTitle":null,"scrollTitleFont":null,"brandSize":null,"brandPrefix":null,"menuButton":null,"paint":null,"order":null,"accentTop":null,"ctaDivider":null,"group":null,"borderSpan":null,"groupOnScroll":null,"phoneLayout":null,"navSeparator":null,"floating":null,"background":null,"activeStyle":null,"activeMatch":null,"sectionCrumb":null,"sectionCrumbSeparator":null,"logoHref":null},"headerLinks":[{"label":null,"href":null,"children":null,"panel":null,"style":null,"highlight":null,"divider":null,"icon":null,"iconDark":null,"iconOnly":null,"githubRepo":null,"match":null,"phone":null,"placement":null,"kbd":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"audience":null}],"navMenu":{"trigger":null,"openDelay":null,"closeDelay":null,"animation":null,"radius":null,"shadow":null,"background":null,"ink":null,"border":null,"width":null},"footerLinks":[{"label":null,"href":null,"audience":null}],"footerDescription":"string","footerColumns":[{"heading":null,"links":null,"stack":null,"audience":null}],"socialLinks":[{"platform":null,"href":null}],"copyright":"string","footer":{"logo":null,"logoMark":null,"cookieLinkPlacement":null,"html":null,"css":null,"htmlPlacement":null,"newsletter":null,"scheme":null,"headingStyle":null,"headingInk":null,"headingInkDark":null,"headingFont":null,"headingSize":null,"headingGap":null,"columnRule":null,"hideOn":null,"headingWeight":null,"bottomAlign":null,"width":null,"contentWidth":null,"font":null,"showBrandName":null,"brandPlacement":null,"brandWidth":null,"columnWidth":null,"padding":null,"bottomSize":null,"htmlSize":null,"htmlLinkInk":null,"htmlLinkInkDark":null,"htmlLinkUnderline":null,"border":null,"bottomRule":null,"linkSize":null,"linkGap":null,"linkInk":null,"linkInkDark":null,"linkWeight":null,"layout":null,"linkSeparator":null,"socialStyle":null,"socialSize":null,"breadcrumb":null,"breadcrumbPlacement":null,"phone":null,"art":null,"status":null,"columns":null,"background":null},"mobileNav":"menu","sticky":true,"height":"compact","align":"split","ctaStyle":"solid","showSignIn":true,"themeToggle":{"show":null,"style":null,"modes":null,"border":null,"hideOn":null,"phone":null,"position":null,"footerAlign":null,"radius":null,"activeColor":null},"sidebarBrand":"show","brandText":"auto","logoPhone":"full","accountMenu":{"items":null,"showName":null,"showAvatar":null,"bell":null},"translations":{},"ctas":[{"label":null,"href":null,"audience":null,"style":null,"background":null,"ink":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"icon":null,"action":null,"phone":null,"inkDark":null,"borderDark":null}],"topBar":{"links":null,"background":null,"ink":null,"height":null,"align":null,"style":null,"phone":null,"button":null,"sticky":null,"font":null,"case":null,"tracking":null},"subnav":{"links":null,"navSize":null,"navWeight":null,"phone":null,"justify":null,"background":null,"ink":null,"border":null,"backgroundDark":null,"inkDark":null,"active":null,"endLinks":null},"search":"none","searchPlacement":"start","searchHideOn":["desktop"],"searchStyle":{"label":null,"background":null,"ink":null,"backgroundDark":null,"inkDark":null,"size":null,"glyph":null,"labelPhone":null,"width":null,"kbd":null,"open":null,"kbdStyle":null,"shrink":null,"iconFrame":null},"desktopNav":"inline","signInStyle":{"look":null,"icon":null,"label":null,"order":null,"phone":null},"sidebarToggle":true,"tagline":"string","tabs":[{"title":null,"slug":null,"spaceIds":null}],"headerSpaceIds":["string"],"theme":{"primaryColor":null,"primaryColorDark":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"colorScheme":null,"colorSchemeStrict":null,"contentWidth":null,"onThisPage":null,"layout":null,"customFontUrl":null,"customFontFamily":null,"brandName":null,"logoIncludesName":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"typography":null,"headingAnchors":null,"fonts":null,"logoUrl":null,"logoMark":null,"logoUrlLight":null,"logoUrlDark":null,"logoDarkMode":null,"faviconUrl":null,"customCss":null,"customJs":null,"scriptOrigins":null,"ads":null,"whiteLabel":null,"showLanguageSwitcher":null,"apiOrigins":null,"fontOrigins":null,"fontOriginsRemoved":null,"imgOrigins":null,"mediaOrigins":null,"frameOrigins":null,"elementStyles":null,"settingsSchema":null,"settings":null,"stringOverrides":null,"cssSnippets":null,"announcement":null,"chrome":null,"notFound":null,"components":null,"changelog":null,"forum":null,"post":null,"docs":null,"footnotes":null,"i18n":null,"status":null,"legal":null,"faq":null,"roadmap":null,"events":null,"courses":null,"careers":null,"contact":null,"motion":null,"titleBand":null,"componentInstalls":null,"mobile":null},"pageMounts":[{"path":null,"spaceId":null,"page":null}]}}'TypeScript
const res = await fetch('https://forumulate.com/api/orgs/{orgId}/sites/{siteId}?dryRun=', {
method: 'PATCH',
headers: {
'forumulate-version': '<value>',
'Idempotency-Key': '<value>',
'Content-Type': 'application/json',
},
body: JSON.stringify({"name":"string","spaceIds":["string"],"config":{"cta":{"label":null,"href":null,"audience":null,"background":null,"ink":null,"size":null,"showOnPhone":null,"border":null,"height":null,"fontSize":null,"icon":null,"phone":null,"inkDark":null,"borderDark":null},"secondaryCta":{"label":null,"href":null,"audience":null,"style":null,"ink":null,"background":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"phone":null,"inkDark":null,"borderDark":null},"header":{"overlay":null,"overlayInk":null,"height":null,"border":null,"borderColor":null,"shadow":null,"blur":null,"opacity":null,"logoHeight":null,"iconSize":null,"navGap":null,"navWeight":null,"navSize":null,"navCase":null,"navTracking":null,"navInk":null,"navInkDark":null,"navFont":null,"linksAlign":null,"maxLinks":null,"controlsAlign":null,"scrollTitle":null,"scrollTitleFont":null,"brandSize":null,"brandPrefix":null,"menuButton":null,"paint":null,"order":null,"accentTop":null,"ctaDivider":null,"group":null,"borderSpan":null,"groupOnScroll":null,"phoneLayout":null,"navSeparator":null,"floating":null,"background":null,"activeStyle":null,"activeMatch":null,"sectionCrumb":null,"sectionCrumbSeparator":null,"logoHref":null},"headerLinks":[{"label":null,"href":null,"children":null,"panel":null,"style":null,"highlight":null,"divider":null,"icon":null,"iconDark":null,"iconOnly":null,"githubRepo":null,"match":null,"phone":null,"placement":null,"kbd":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"audience":null}],"navMenu":{"trigger":null,"openDelay":null,"closeDelay":null,"animation":null,"radius":null,"shadow":null,"background":null,"ink":null,"border":null,"width":null},"footerLinks":[{"label":null,"href":null,"audience":null}],"footerDescription":"string","footerColumns":[{"heading":null,"links":null,"stack":null,"audience":null}],"socialLinks":[{"platform":null,"href":null}],"copyright":"string","footer":{"logo":null,"logoMark":null,"cookieLinkPlacement":null,"html":null,"css":null,"htmlPlacement":null,"newsletter":null,"scheme":null,"headingStyle":null,"headingInk":null,"headingInkDark":null,"headingFont":null,"headingSize":null,"headingGap":null,"columnRule":null,"hideOn":null,"headingWeight":null,"bottomAlign":null,"width":null,"contentWidth":null,"font":null,"showBrandName":null,"brandPlacement":null,"brandWidth":null,"columnWidth":null,"padding":null,"bottomSize":null,"htmlSize":null,"htmlLinkInk":null,"htmlLinkInkDark":null,"htmlLinkUnderline":null,"border":null,"bottomRule":null,"linkSize":null,"linkGap":null,"linkInk":null,"linkInkDark":null,"linkWeight":null,"layout":null,"linkSeparator":null,"socialStyle":null,"socialSize":null,"breadcrumb":null,"breadcrumbPlacement":null,"phone":null,"art":null,"status":null,"columns":null,"background":null},"mobileNav":"menu","sticky":true,"height":"compact","align":"split","ctaStyle":"solid","showSignIn":true,"themeToggle":{"show":null,"style":null,"modes":null,"border":null,"hideOn":null,"phone":null,"position":null,"footerAlign":null,"radius":null,"activeColor":null},"sidebarBrand":"show","brandText":"auto","logoPhone":"full","accountMenu":{"items":null,"showName":null,"showAvatar":null,"bell":null},"translations":{},"ctas":[{"label":null,"href":null,"audience":null,"style":null,"background":null,"ink":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"icon":null,"action":null,"phone":null,"inkDark":null,"borderDark":null}],"topBar":{"links":null,"background":null,"ink":null,"height":null,"align":null,"style":null,"phone":null,"button":null,"sticky":null,"font":null,"case":null,"tracking":null},"subnav":{"links":null,"navSize":null,"navWeight":null,"phone":null,"justify":null,"background":null,"ink":null,"border":null,"backgroundDark":null,"inkDark":null,"active":null,"endLinks":null},"search":"none","searchPlacement":"start","searchHideOn":["desktop"],"searchStyle":{"label":null,"background":null,"ink":null,"backgroundDark":null,"inkDark":null,"size":null,"glyph":null,"labelPhone":null,"width":null,"kbd":null,"open":null,"kbdStyle":null,"shrink":null,"iconFrame":null},"desktopNav":"inline","signInStyle":{"look":null,"icon":null,"label":null,"order":null,"phone":null},"sidebarToggle":true,"tagline":"string","tabs":[{"title":null,"slug":null,"spaceIds":null}],"headerSpaceIds":["string"],"theme":{"primaryColor":null,"primaryColorDark":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"colorScheme":null,"colorSchemeStrict":null,"contentWidth":null,"onThisPage":null,"layout":null,"customFontUrl":null,"customFontFamily":null,"brandName":null,"logoIncludesName":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"typography":null,"headingAnchors":null,"fonts":null,"logoUrl":null,"logoMark":null,"logoUrlLight":null,"logoUrlDark":null,"logoDarkMode":null,"faviconUrl":null,"customCss":null,"customJs":null,"scriptOrigins":null,"ads":null,"whiteLabel":null,"showLanguageSwitcher":null,"apiOrigins":null,"fontOrigins":null,"fontOriginsRemoved":null,"imgOrigins":null,"mediaOrigins":null,"frameOrigins":null,"elementStyles":null,"settingsSchema":null,"settings":null,"stringOverrides":null,"cssSnippets":null,"announcement":null,"chrome":null,"notFound":null,"components":null,"changelog":null,"forum":null,"post":null,"docs":null,"footnotes":null,"i18n":null,"status":null,"legal":null,"faq":null,"roadmap":null,"events":null,"courses":null,"careers":null,"contact":null,"motion":null,"titleBand":null,"componentInstalls":null,"mobile":null},"pageMounts":[{"path":null,"spaceId":null,"page":null}]}}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PATCH",
"https://forumulate.com/api/orgs/{orgId}/sites/{siteId}?dryRun=",
headers={
"forumulate-version": "<value>",
"Idempotency-Key": "<value>",
"Content-Type": "application/json",
},
json={"name": "string", "spaceIds": ["string"], "config": {"cta": {"label": None, "href": None, "audience": None, "background": None, "ink": None, "size": None, "showOnPhone": None, "border": None, "height": None, "fontSize": None, "icon": None, "phone": None, "inkDark": None, "borderDark": None}, "secondaryCta": {"label": None, "href": None, "audience": None, "style": None, "ink": None, "background": None, "underline": None, "size": None, "border": None, "showOnPhone": None, "height": None, "fontSize": None, "phone": None, "inkDark": None, "borderDark": None}, "header": {"overlay": None, "overlayInk": None, "height": None, "border": None, "borderColor": None, "shadow": None, "blur": None, "opacity": None, "logoHeight": None, "iconSize": None, "navGap": None, "navWeight": None, "navSize": None, "navCase": None, "navTracking": None, "navInk": None, "navInkDark": None, "navFont": None, "linksAlign": None, "maxLinks": None, "controlsAlign": None, "scrollTitle": None, "scrollTitleFont": None, "brandSize": None, "brandPrefix": None, "menuButton": None, "paint": None, "order": None, "accentTop": None, "ctaDivider": None, "group": None, "borderSpan": None, "groupOnScroll": None, "phoneLayout": None, "navSeparator": None, "floating": None, "background": None, "activeStyle": None, "activeMatch": None, "sectionCrumb": None, "sectionCrumbSeparator": None, "logoHref": None}, "headerLinks": [{"label": None, "href": None, "children": None, "panel": None, "style": None, "highlight": None, "divider": None, "icon": None, "iconDark": None, "iconOnly": None, "githubRepo": None, "match": None, "phone": None, "placement": None, "kbd": None, "ink": None, "inkDark": None, "border": None, "borderDark": None, "audience": None}], "navMenu": {"trigger": None, "openDelay": None, "closeDelay": None, "animation": None, "radius": None, "shadow": None, "background": None, "ink": None, "border": None, "width": None}, "footerLinks": [{"label": None, "href": None, "audience": None}], "footerDescription": "string", "footerColumns": [{"heading": None, "links": None, "stack": None, "audience": None}], "socialLinks": [{"platform": None, "href": None}], "copyright": "string", "footer": {"logo": None, "logoMark": None, "cookieLinkPlacement": None, "html": None, "css": None, "htmlPlacement": None, "newsletter": None, "scheme": None, "headingStyle": None, "headingInk": None, "headingInkDark": None, "headingFont": None, "headingSize": None, "headingGap": None, "columnRule": None, "hideOn": None, "headingWeight": None, "bottomAlign": None, "width": None, "contentWidth": None, "font": None, "showBrandName": None, "brandPlacement": None, "brandWidth": None, "columnWidth": None, "padding": None, "bottomSize": None, "htmlSize": None, "htmlLinkInk": None, "htmlLinkInkDark": None, "htmlLinkUnderline": None, "border": None, "bottomRule": None, "linkSize": None, "linkGap": None, "linkInk": None, "linkInkDark": None, "linkWeight": None, "layout": None, "linkSeparator": None, "socialStyle": None, "socialSize": None, "breadcrumb": None, "breadcrumbPlacement": None, "phone": None, "art": None, "status": None, "columns": None, "background": None}, "mobileNav": "menu", "sticky": True, "height": "compact", "align": "split", "ctaStyle": "solid", "showSignIn": True, "themeToggle": {"show": None, "style": None, "modes": None, "border": None, "hideOn": None, "phone": None, "position": None, "footerAlign": None, "radius": None, "activeColor": None}, "sidebarBrand": "show", "brandText": "auto", "logoPhone": "full", "accountMenu": {"items": None, "showName": None, "showAvatar": None, "bell": None}, "translations": {}, "ctas": [{"label": None, "href": None, "audience": None, "style": None, "background": None, "ink": None, "underline": None, "size": None, "border": None, "showOnPhone": None, "height": None, "fontSize": None, "icon": None, "action": None, "phone": None, "inkDark": None, "borderDark": None}], "topBar": {"links": None, "background": None, "ink": None, "height": None, "align": None, "style": None, "phone": None, "button": None, "sticky": None, "font": None, "case": None, "tracking": None}, "subnav": {"links": None, "navSize": None, "navWeight": None, "phone": None, "justify": None, "background": None, "ink": None, "border": None, "backgroundDark": None, "inkDark": None, "active": None, "endLinks": None}, "search": "none", "searchPlacement": "start", "searchHideOn": ["desktop"], "searchStyle": {"label": None, "background": None, "ink": None, "backgroundDark": None, "inkDark": None, "size": None, "glyph": None, "labelPhone": None, "width": None, "kbd": None, "open": None, "kbdStyle": None, "shrink": None, "iconFrame": None}, "desktopNav": "inline", "signInStyle": {"look": None, "icon": None, "label": None, "order": None, "phone": None}, "sidebarToggle": True, "tagline": "string", "tabs": [{"title": None, "slug": None, "spaceIds": None}], "headerSpaceIds": ["string"], "theme": {"primaryColor": None, "primaryColorDark": None, "accentColor": None, "palette": None, "paletteDark": None, "font": None, "colorScheme": None, "colorSchemeStrict": None, "contentWidth": None, "onThisPage": None, "layout": None, "customFontUrl": None, "customFontFamily": None, "brandName": None, "logoIncludesName": None, "headingFontFamily": None, "bodyFontFamily": None, "monoFontFamily": None, "typography": None, "headingAnchors": None, "fonts": None, "logoUrl": None, "logoMark": None, "logoUrlLight": None, "logoUrlDark": None, "logoDarkMode": None, "faviconUrl": None, "customCss": None, "customJs": None, "scriptOrigins": None, "ads": None, "whiteLabel": None, "showLanguageSwitcher": None, "apiOrigins": None, "fontOrigins": None, "fontOriginsRemoved": None, "imgOrigins": None, "mediaOrigins": None, "frameOrigins": None, "elementStyles": None, "settingsSchema": None, "settings": None, "stringOverrides": None, "cssSnippets": None, "announcement": None, "chrome": None, "notFound": None, "components": None, "changelog": None, "forum": None, "post": None, "docs": None, "footnotes": None, "i18n": None, "status": None, "legal": None, "faq": None, "roadmap": None, "events": None, "courses": None, "careers": None, "contact": None, "motion": None, "titleBand": None, "componentInstalls": None, "mobile": None}, "pageMounts": [{"path": None, "spaceId": None, "page": None}]}},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://forumulate.com/api/orgs/{orgId}/sites/{siteId}?dryRun=", strings.NewReader(`{"name":"string","spaceIds":["string"],"config":{"cta":{"label":null,"href":null,"audience":null,"background":null,"ink":null,"size":null,"showOnPhone":null,"border":null,"height":null,"fontSize":null,"icon":null,"phone":null,"inkDark":null,"borderDark":null},"secondaryCta":{"label":null,"href":null,"audience":null,"style":null,"ink":null,"background":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"phone":null,"inkDark":null,"borderDark":null},"header":{"overlay":null,"overlayInk":null,"height":null,"border":null,"borderColor":null,"shadow":null,"blur":null,"opacity":null,"logoHeight":null,"iconSize":null,"navGap":null,"navWeight":null,"navSize":null,"navCase":null,"navTracking":null,"navInk":null,"navInkDark":null,"navFont":null,"linksAlign":null,"maxLinks":null,"controlsAlign":null,"scrollTitle":null,"scrollTitleFont":null,"brandSize":null,"brandPrefix":null,"menuButton":null,"paint":null,"order":null,"accentTop":null,"ctaDivider":null,"group":null,"borderSpan":null,"groupOnScroll":null,"phoneLayout":null,"navSeparator":null,"floating":null,"background":null,"activeStyle":null,"activeMatch":null,"sectionCrumb":null,"sectionCrumbSeparator":null,"logoHref":null},"headerLinks":[{"label":null,"href":null,"children":null,"panel":null,"style":null,"highlight":null,"divider":null,"icon":null,"iconDark":null,"iconOnly":null,"githubRepo":null,"match":null,"phone":null,"placement":null,"kbd":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"audience":null}],"navMenu":{"trigger":null,"openDelay":null,"closeDelay":null,"animation":null,"radius":null,"shadow":null,"background":null,"ink":null,"border":null,"width":null},"footerLinks":[{"label":null,"href":null,"audience":null}],"footerDescription":"string","footerColumns":[{"heading":null,"links":null,"stack":null,"audience":null}],"socialLinks":[{"platform":null,"href":null}],"copyright":"string","footer":{"logo":null,"logoMark":null,"cookieLinkPlacement":null,"html":null,"css":null,"htmlPlacement":null,"newsletter":null,"scheme":null,"headingStyle":null,"headingInk":null,"headingInkDark":null,"headingFont":null,"headingSize":null,"headingGap":null,"columnRule":null,"hideOn":null,"headingWeight":null,"bottomAlign":null,"width":null,"contentWidth":null,"font":null,"showBrandName":null,"brandPlacement":null,"brandWidth":null,"columnWidth":null,"padding":null,"bottomSize":null,"htmlSize":null,"htmlLinkInk":null,"htmlLinkInkDark":null,"htmlLinkUnderline":null,"border":null,"bottomRule":null,"linkSize":null,"linkGap":null,"linkInk":null,"linkInkDark":null,"linkWeight":null,"layout":null,"linkSeparator":null,"socialStyle":null,"socialSize":null,"breadcrumb":null,"breadcrumbPlacement":null,"phone":null,"art":null,"status":null,"columns":null,"background":null},"mobileNav":"menu","sticky":true,"height":"compact","align":"split","ctaStyle":"solid","showSignIn":true,"themeToggle":{"show":null,"style":null,"modes":null,"border":null,"hideOn":null,"phone":null,"position":null,"footerAlign":null,"radius":null,"activeColor":null},"sidebarBrand":"show","brandText":"auto","logoPhone":"full","accountMenu":{"items":null,"showName":null,"showAvatar":null,"bell":null},"translations":{},"ctas":[{"label":null,"href":null,"audience":null,"style":null,"background":null,"ink":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"icon":null,"action":null,"phone":null,"inkDark":null,"borderDark":null}],"topBar":{"links":null,"background":null,"ink":null,"height":null,"align":null,"style":null,"phone":null,"button":null,"sticky":null,"font":null,"case":null,"tracking":null},"subnav":{"links":null,"navSize":null,"navWeight":null,"phone":null,"justify":null,"background":null,"ink":null,"border":null,"backgroundDark":null,"inkDark":null,"active":null,"endLinks":null},"search":"none","searchPlacement":"start","searchHideOn":["desktop"],"searchStyle":{"label":null,"background":null,"ink":null,"backgroundDark":null,"inkDark":null,"size":null,"glyph":null,"labelPhone":null,"width":null,"kbd":null,"open":null,"kbdStyle":null,"shrink":null,"iconFrame":null},"desktopNav":"inline","signInStyle":{"look":null,"icon":null,"label":null,"order":null,"phone":null},"sidebarToggle":true,"tagline":"string","tabs":[{"title":null,"slug":null,"spaceIds":null}],"headerSpaceIds":["string"],"theme":{"primaryColor":null,"primaryColorDark":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"colorScheme":null,"colorSchemeStrict":null,"contentWidth":null,"onThisPage":null,"layout":null,"customFontUrl":null,"customFontFamily":null,"brandName":null,"logoIncludesName":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"typography":null,"headingAnchors":null,"fonts":null,"logoUrl":null,"logoMark":null,"logoUrlLight":null,"logoUrlDark":null,"logoDarkMode":null,"faviconUrl":null,"customCss":null,"customJs":null,"scriptOrigins":null,"ads":null,"whiteLabel":null,"showLanguageSwitcher":null,"apiOrigins":null,"fontOrigins":null,"fontOriginsRemoved":null,"imgOrigins":null,"mediaOrigins":null,"frameOrigins":null,"elementStyles":null,"settingsSchema":null,"settings":null,"stringOverrides":null,"cssSnippets":null,"announcement":null,"chrome":null,"notFound":null,"components":null,"changelog":null,"forum":null,"post":null,"docs":null,"footnotes":null,"i18n":null,"status":null,"legal":null,"faq":null,"roadmap":null,"events":null,"courses":null,"careers":null,"contact":null,"motion":null,"titleBand":null,"componentInstalls":null,"mobile":null},"pageMounts":[{"path":null,"spaceId":null,"page":null}]}}`))
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}/sites/{siteId}?dryRun=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['forumulate-version: <value>', 'Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","spaceIds":["string"],"config":{"cta":{"label":null,"href":null,"audience":null,"background":null,"ink":null,"size":null,"showOnPhone":null,"border":null,"height":null,"fontSize":null,"icon":null,"phone":null,"inkDark":null,"borderDark":null},"secondaryCta":{"label":null,"href":null,"audience":null,"style":null,"ink":null,"background":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"phone":null,"inkDark":null,"borderDark":null},"header":{"overlay":null,"overlayInk":null,"height":null,"border":null,"borderColor":null,"shadow":null,"blur":null,"opacity":null,"logoHeight":null,"iconSize":null,"navGap":null,"navWeight":null,"navSize":null,"navCase":null,"navTracking":null,"navInk":null,"navInkDark":null,"navFont":null,"linksAlign":null,"maxLinks":null,"controlsAlign":null,"scrollTitle":null,"scrollTitleFont":null,"brandSize":null,"brandPrefix":null,"menuButton":null,"paint":null,"order":null,"accentTop":null,"ctaDivider":null,"group":null,"borderSpan":null,"groupOnScroll":null,"phoneLayout":null,"navSeparator":null,"floating":null,"background":null,"activeStyle":null,"activeMatch":null,"sectionCrumb":null,"sectionCrumbSeparator":null,"logoHref":null},"headerLinks":[{"label":null,"href":null,"children":null,"panel":null,"style":null,"highlight":null,"divider":null,"icon":null,"iconDark":null,"iconOnly":null,"githubRepo":null,"match":null,"phone":null,"placement":null,"kbd":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"audience":null}],"navMenu":{"trigger":null,"openDelay":null,"closeDelay":null,"animation":null,"radius":null,"shadow":null,"background":null,"ink":null,"border":null,"width":null},"footerLinks":[{"label":null,"href":null,"audience":null}],"footerDescription":"string","footerColumns":[{"heading":null,"links":null,"stack":null,"audience":null}],"socialLinks":[{"platform":null,"href":null}],"copyright":"string","footer":{"logo":null,"logoMark":null,"cookieLinkPlacement":null,"html":null,"css":null,"htmlPlacement":null,"newsletter":null,"scheme":null,"headingStyle":null,"headingInk":null,"headingInkDark":null,"headingFont":null,"headingSize":null,"headingGap":null,"columnRule":null,"hideOn":null,"headingWeight":null,"bottomAlign":null,"width":null,"contentWidth":null,"font":null,"showBrandName":null,"brandPlacement":null,"brandWidth":null,"columnWidth":null,"padding":null,"bottomSize":null,"htmlSize":null,"htmlLinkInk":null,"htmlLinkInkDark":null,"htmlLinkUnderline":null,"border":null,"bottomRule":null,"linkSize":null,"linkGap":null,"linkInk":null,"linkInkDark":null,"linkWeight":null,"layout":null,"linkSeparator":null,"socialStyle":null,"socialSize":null,"breadcrumb":null,"breadcrumbPlacement":null,"phone":null,"art":null,"status":null,"columns":null,"background":null},"mobileNav":"menu","sticky":true,"height":"compact","align":"split","ctaStyle":"solid","showSignIn":true,"themeToggle":{"show":null,"style":null,"modes":null,"border":null,"hideOn":null,"phone":null,"position":null,"footerAlign":null,"radius":null,"activeColor":null},"sidebarBrand":"show","brandText":"auto","logoPhone":"full","accountMenu":{"items":null,"showName":null,"showAvatar":null,"bell":null},"translations":{},"ctas":[{"label":null,"href":null,"audience":null,"style":null,"background":null,"ink":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"icon":null,"action":null,"phone":null,"inkDark":null,"borderDark":null}],"topBar":{"links":null,"background":null,"ink":null,"height":null,"align":null,"style":null,"phone":null,"button":null,"sticky":null,"font":null,"case":null,"tracking":null},"subnav":{"links":null,"navSize":null,"navWeight":null,"phone":null,"justify":null,"background":null,"ink":null,"border":null,"backgroundDark":null,"inkDark":null,"active":null,"endLinks":null},"search":"none","searchPlacement":"start","searchHideOn":["desktop"],"searchStyle":{"label":null,"background":null,"ink":null,"backgroundDark":null,"inkDark":null,"size":null,"glyph":null,"labelPhone":null,"width":null,"kbd":null,"open":null,"kbdStyle":null,"shrink":null,"iconFrame":null},"desktopNav":"inline","signInStyle":{"look":null,"icon":null,"label":null,"order":null,"phone":null},"sidebarToggle":true,"tagline":"string","tabs":[{"title":null,"slug":null,"spaceIds":null}],"headerSpaceIds":["string"],"theme":{"primaryColor":null,"primaryColorDark":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"colorScheme":null,"colorSchemeStrict":null,"contentWidth":null,"onThisPage":null,"layout":null,"customFontUrl":null,"customFontFamily":null,"brandName":null,"logoIncludesName":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"typography":null,"headingAnchors":null,"fonts":null,"logoUrl":null,"logoMark":null,"logoUrlLight":null,"logoUrlDark":null,"logoDarkMode":null,"faviconUrl":null,"customCss":null,"customJs":null,"scriptOrigins":null,"ads":null,"whiteLabel":null,"showLanguageSwitcher":null,"apiOrigins":null,"fontOrigins":null,"fontOriginsRemoved":null,"imgOrigins":null,"mediaOrigins":null,"frameOrigins":null,"elementStyles":null,"settingsSchema":null,"settings":null,"stringOverrides":null,"cssSnippets":null,"announcement":null,"chrome":null,"notFound":null,"components":null,"changelog":null,"forum":null,"post":null,"docs":null,"footnotes":null,"i18n":null,"status":null,"legal":null,"faq":null,"roadmap":null,"events":null,"courses":null,"careers":null,"contact":null,"motion":null,"titleBand":null,"componentInstalls":null,"mobile":null},"pageMounts":[{"path":null,"spaceId":null,"page":null}]}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://forumulate.com/api/orgs/{orgId}/sites/{siteId}?dryRun=')
req = Net::HTTP::Patch.new(uri)
req['forumulate-version'] = '<value>'
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","spaceIds":["string"],"config":{"cta":{"label":null,"href":null,"audience":null,"background":null,"ink":null,"size":null,"showOnPhone":null,"border":null,"height":null,"fontSize":null,"icon":null,"phone":null,"inkDark":null,"borderDark":null},"secondaryCta":{"label":null,"href":null,"audience":null,"style":null,"ink":null,"background":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"phone":null,"inkDark":null,"borderDark":null},"header":{"overlay":null,"overlayInk":null,"height":null,"border":null,"borderColor":null,"shadow":null,"blur":null,"opacity":null,"logoHeight":null,"iconSize":null,"navGap":null,"navWeight":null,"navSize":null,"navCase":null,"navTracking":null,"navInk":null,"navInkDark":null,"navFont":null,"linksAlign":null,"maxLinks":null,"controlsAlign":null,"scrollTitle":null,"scrollTitleFont":null,"brandSize":null,"brandPrefix":null,"menuButton":null,"paint":null,"order":null,"accentTop":null,"ctaDivider":null,"group":null,"borderSpan":null,"groupOnScroll":null,"phoneLayout":null,"navSeparator":null,"floating":null,"background":null,"activeStyle":null,"activeMatch":null,"sectionCrumb":null,"sectionCrumbSeparator":null,"logoHref":null},"headerLinks":[{"label":null,"href":null,"children":null,"panel":null,"style":null,"highlight":null,"divider":null,"icon":null,"iconDark":null,"iconOnly":null,"githubRepo":null,"match":null,"phone":null,"placement":null,"kbd":null,"ink":null,"inkDark":null,"border":null,"borderDark":null,"audience":null}],"navMenu":{"trigger":null,"openDelay":null,"closeDelay":null,"animation":null,"radius":null,"shadow":null,"background":null,"ink":null,"border":null,"width":null},"footerLinks":[{"label":null,"href":null,"audience":null}],"footerDescription":"string","footerColumns":[{"heading":null,"links":null,"stack":null,"audience":null}],"socialLinks":[{"platform":null,"href":null}],"copyright":"string","footer":{"logo":null,"logoMark":null,"cookieLinkPlacement":null,"html":null,"css":null,"htmlPlacement":null,"newsletter":null,"scheme":null,"headingStyle":null,"headingInk":null,"headingInkDark":null,"headingFont":null,"headingSize":null,"headingGap":null,"columnRule":null,"hideOn":null,"headingWeight":null,"bottomAlign":null,"width":null,"contentWidth":null,"font":null,"showBrandName":null,"brandPlacement":null,"brandWidth":null,"columnWidth":null,"padding":null,"bottomSize":null,"htmlSize":null,"htmlLinkInk":null,"htmlLinkInkDark":null,"htmlLinkUnderline":null,"border":null,"bottomRule":null,"linkSize":null,"linkGap":null,"linkInk":null,"linkInkDark":null,"linkWeight":null,"layout":null,"linkSeparator":null,"socialStyle":null,"socialSize":null,"breadcrumb":null,"breadcrumbPlacement":null,"phone":null,"art":null,"status":null,"columns":null,"background":null},"mobileNav":"menu","sticky":true,"height":"compact","align":"split","ctaStyle":"solid","showSignIn":true,"themeToggle":{"show":null,"style":null,"modes":null,"border":null,"hideOn":null,"phone":null,"position":null,"footerAlign":null,"radius":null,"activeColor":null},"sidebarBrand":"show","brandText":"auto","logoPhone":"full","accountMenu":{"items":null,"showName":null,"showAvatar":null,"bell":null},"translations":{},"ctas":[{"label":null,"href":null,"audience":null,"style":null,"background":null,"ink":null,"underline":null,"size":null,"border":null,"showOnPhone":null,"height":null,"fontSize":null,"icon":null,"action":null,"phone":null,"inkDark":null,"borderDark":null}],"topBar":{"links":null,"background":null,"ink":null,"height":null,"align":null,"style":null,"phone":null,"button":null,"sticky":null,"font":null,"case":null,"tracking":null},"subnav":{"links":null,"navSize":null,"navWeight":null,"phone":null,"justify":null,"background":null,"ink":null,"border":null,"backgroundDark":null,"inkDark":null,"active":null,"endLinks":null},"search":"none","searchPlacement":"start","searchHideOn":["desktop"],"searchStyle":{"label":null,"background":null,"ink":null,"backgroundDark":null,"inkDark":null,"size":null,"glyph":null,"labelPhone":null,"width":null,"kbd":null,"open":null,"kbdStyle":null,"shrink":null,"iconFrame":null},"desktopNav":"inline","signInStyle":{"look":null,"icon":null,"label":null,"order":null,"phone":null},"sidebarToggle":true,"tagline":"string","tabs":[{"title":null,"slug":null,"spaceIds":null}],"headerSpaceIds":["string"],"theme":{"primaryColor":null,"primaryColorDark":null,"accentColor":null,"palette":null,"paletteDark":null,"font":null,"colorScheme":null,"colorSchemeStrict":null,"contentWidth":null,"onThisPage":null,"layout":null,"customFontUrl":null,"customFontFamily":null,"brandName":null,"logoIncludesName":null,"headingFontFamily":null,"bodyFontFamily":null,"monoFontFamily":null,"typography":null,"headingAnchors":null,"fonts":null,"logoUrl":null,"logoMark":null,"logoUrlLight":null,"logoUrlDark":null,"logoDarkMode":null,"faviconUrl":null,"customCss":null,"customJs":null,"scriptOrigins":null,"ads":null,"whiteLabel":null,"showLanguageSwitcher":null,"apiOrigins":null,"fontOrigins":null,"fontOriginsRemoved":null,"imgOrigins":null,"mediaOrigins":null,"frameOrigins":null,"elementStyles":null,"settingsSchema":null,"settings":null,"stringOverrides":null,"cssSnippets":null,"announcement":null,"chrome":null,"notFound":null,"components":null,"changelog":null,"forum":null,"post":null,"docs":null,"footnotes":null,"i18n":null,"status":null,"legal":null,"faq":null,"roadmap":null,"events":null,"courses":null,"careers":null,"contact":null,"motion":null,"titleBand":null,"componentInstalls":null,"mobile":null},"pageMounts":[{"path":null,"spaceId":null,"page":null}]}}'
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}/sites/{siteId}?dryRun="))
.header("forumulate-version", "<value>")
.header("Idempotency-Key", "<value>")
.header("Content-Type", "application/json")
.method("PATCH", BodyPublishers.ofString("{\"name\":\"string\",\"spaceIds\":[\"string\"],\"config\":{\"cta\":{\"label\":null,\"href\":null,\"audience\":null,\"background\":null,\"ink\":null,\"size\":null,\"showOnPhone\":null,\"border\":null,\"height\":null,\"fontSize\":null,\"icon\":null,\"phone\":null,\"inkDark\":null,\"borderDark\":null},\"secondaryCta\":{\"label\":null,\"href\":null,\"audience\":null,\"style\":null,\"ink\":null,\"background\":null,\"underline\":null,\"size\":null,\"border\":null,\"showOnPhone\":null,\"height\":null,\"fontSize\":null,\"phone\":null,\"inkDark\":null,\"borderDark\":null},\"header\":{\"overlay\":null,\"overlayInk\":null,\"height\":null,\"border\":null,\"borderColor\":null,\"shadow\":null,\"blur\":null,\"opacity\":null,\"logoHeight\":null,\"iconSize\":null,\"navGap\":null,\"navWeight\":null,\"navSize\":null,\"navCase\":null,\"navTracking\":null,\"navInk\":null,\"navInkDark\":null,\"navFont\":null,\"linksAlign\":null,\"maxLinks\":null,\"controlsAlign\":null,\"scrollTitle\":null,\"scrollTitleFont\":null,\"brandSize\":null,\"brandPrefix\":null,\"menuButton\":null,\"paint\":null,\"order\":null,\"accentTop\":null,\"ctaDivider\":null,\"group\":null,\"borderSpan\":null,\"groupOnScroll\":null,\"phoneLayout\":null,\"navSeparator\":null,\"floating\":null,\"background\":null,\"activeStyle\":null,\"activeMatch\":null,\"sectionCrumb\":null,\"sectionCrumbSeparator\":null,\"logoHref\":null},\"headerLinks\":[{\"label\":null,\"href\":null,\"children\":null,\"panel\":null,\"style\":null,\"highlight\":null,\"divider\":null,\"icon\":null,\"iconDark\":null,\"iconOnly\":null,\"githubRepo\":null,\"match\":null,\"phone\":null,\"placement\":null,\"kbd\":null,\"ink\":null,\"inkDark\":null,\"border\":null,\"borderDark\":null,\"audience\":null}],\"navMenu\":{\"trigger\":null,\"openDelay\":null,\"closeDelay\":null,\"animation\":null,\"radius\":null,\"shadow\":null,\"background\":null,\"ink\":null,\"border\":null,\"width\":null},\"footerLinks\":[{\"label\":null,\"href\":null,\"audience\":null}],\"footerDescription\":\"string\",\"footerColumns\":[{\"heading\":null,\"links\":null,\"stack\":null,\"audience\":null}],\"socialLinks\":[{\"platform\":null,\"href\":null}],\"copyright\":\"string\",\"footer\":{\"logo\":null,\"logoMark\":null,\"cookieLinkPlacement\":null,\"html\":null,\"css\":null,\"htmlPlacement\":null,\"newsletter\":null,\"scheme\":null,\"headingStyle\":null,\"headingInk\":null,\"headingInkDark\":null,\"headingFont\":null,\"headingSize\":null,\"headingGap\":null,\"columnRule\":null,\"hideOn\":null,\"headingWeight\":null,\"bottomAlign\":null,\"width\":null,\"contentWidth\":null,\"font\":null,\"showBrandName\":null,\"brandPlacement\":null,\"brandWidth\":null,\"columnWidth\":null,\"padding\":null,\"bottomSize\":null,\"htmlSize\":null,\"htmlLinkInk\":null,\"htmlLinkInkDark\":null,\"htmlLinkUnderline\":null,\"border\":null,\"bottomRule\":null,\"linkSize\":null,\"linkGap\":null,\"linkInk\":null,\"linkInkDark\":null,\"linkWeight\":null,\"layout\":null,\"linkSeparator\":null,\"socialStyle\":null,\"socialSize\":null,\"breadcrumb\":null,\"breadcrumbPlacement\":null,\"phone\":null,\"art\":null,\"status\":null,\"columns\":null,\"background\":null},\"mobileNav\":\"menu\",\"sticky\":true,\"height\":\"compact\",\"align\":\"split\",\"ctaStyle\":\"solid\",\"showSignIn\":true,\"themeToggle\":{\"show\":null,\"style\":null,\"modes\":null,\"border\":null,\"hideOn\":null,\"phone\":null,\"position\":null,\"footerAlign\":null,\"radius\":null,\"activeColor\":null},\"sidebarBrand\":\"show\",\"brandText\":\"auto\",\"logoPhone\":\"full\",\"accountMenu\":{\"items\":null,\"showName\":null,\"showAvatar\":null,\"bell\":null},\"translations\":{},\"ctas\":[{\"label\":null,\"href\":null,\"audience\":null,\"style\":null,\"background\":null,\"ink\":null,\"underline\":null,\"size\":null,\"border\":null,\"showOnPhone\":null,\"height\":null,\"fontSize\":null,\"icon\":null,\"action\":null,\"phone\":null,\"inkDark\":null,\"borderDark\":null}],\"topBar\":{\"links\":null,\"background\":null,\"ink\":null,\"height\":null,\"align\":null,\"style\":null,\"phone\":null,\"button\":null,\"sticky\":null,\"font\":null,\"case\":null,\"tracking\":null},\"subnav\":{\"links\":null,\"navSize\":null,\"navWeight\":null,\"phone\":null,\"justify\":null,\"background\":null,\"ink\":null,\"border\":null,\"backgroundDark\":null,\"inkDark\":null,\"active\":null,\"endLinks\":null},\"search\":\"none\",\"searchPlacement\":\"start\",\"searchHideOn\":[\"desktop\"],\"searchStyle\":{\"label\":null,\"background\":null,\"ink\":null,\"backgroundDark\":null,\"inkDark\":null,\"size\":null,\"glyph\":null,\"labelPhone\":null,\"width\":null,\"kbd\":null,\"open\":null,\"kbdStyle\":null,\"shrink\":null,\"iconFrame\":null},\"desktopNav\":\"inline\",\"signInStyle\":{\"look\":null,\"icon\":null,\"label\":null,\"order\":null,\"phone\":null},\"sidebarToggle\":true,\"tagline\":\"string\",\"tabs\":[{\"title\":null,\"slug\":null,\"spaceIds\":null}],\"headerSpaceIds\":[\"string\"],\"theme\":{\"primaryColor\":null,\"primaryColorDark\":null,\"accentColor\":null,\"palette\":null,\"paletteDark\":null,\"font\":null,\"colorScheme\":null,\"colorSchemeStrict\":null,\"contentWidth\":null,\"onThisPage\":null,\"layout\":null,\"customFontUrl\":null,\"customFontFamily\":null,\"brandName\":null,\"logoIncludesName\":null,\"headingFontFamily\":null,\"bodyFontFamily\":null,\"monoFontFamily\":null,\"typography\":null,\"headingAnchors\":null,\"fonts\":null,\"logoUrl\":null,\"logoMark\":null,\"logoUrlLight\":null,\"logoUrlDark\":null,\"logoDarkMode\":null,\"faviconUrl\":null,\"customCss\":null,\"customJs\":null,\"scriptOrigins\":null,\"ads\":null,\"whiteLabel\":null,\"showLanguageSwitcher\":null,\"apiOrigins\":null,\"fontOrigins\":null,\"fontOriginsRemoved\":null,\"imgOrigins\":null,\"mediaOrigins\":null,\"frameOrigins\":null,\"elementStyles\":null,\"settingsSchema\":null,\"settings\":null,\"stringOverrides\":null,\"cssSnippets\":null,\"announcement\":null,\"chrome\":null,\"notFound\":null,\"components\":null,\"changelog\":null,\"forum\":null,\"post\":null,\"docs\":null,\"footnotes\":null,\"i18n\":null,\"status\":null,\"legal\":null,\"faq\":null,\"roadmap\":null,\"events\":null,\"courses\":null,\"careers\":null,\"contact\":null,\"motion\":null,\"titleBand\":null,\"componentInstalls\":null,\"mobile\":null},\"pageMounts\":[{\"path\":null,\"spaceId\":null,\"page\":null}]}}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 Success.
{
"contrastWarnings": [
{
"code": "contrast.low",
"key": "palette.muted",
"message": "palette.muted (#9aa0a8) on palette.background (#f3f1ea) is 2.33:1 in light mode; text needs 4.5:1 (WCAG AA)."
}
],
"diff": [
{
"from": {},
"op": "add",
"path": "string",
"to": {}
}
],
"dryRun": true,
"site": {
"config": {
"copyright": "string",
"cta": {
"href": null,
"label": null
},
"footer": {
"art": null,
"background": null,
"border": null,
"bottomAlign": null,
"bottomRule": null,
"bottomSize": null,
"brandPlacement": null,
"brandWidth": null,
"breadcrumb": null,
"breadcrumbPlacement": null,
"columnRule": null,
"columns": null,
"columnWidth": null,
"contentWidth": null,
"cookieLinkPlacement": null,
"css": null,
"font": null,
"headingFont": null,
"headingGap": null,
"headingInk": null,
"headingInkDark": null,
"headingSize": null,
"headingStyle": null,
"headingWeight": null,
"hideOn": null,
"html": null,
"htmlLinkInk": null,
"htmlLinkInkDark": null,
"htmlLinkUnderline": null,
"htmlPlacement": null,
"htmlSize": null,
"layout": null,
"linkGap": null,
"linkInk": null,
"linkInkDark": null,
"linkSeparator": null,
"linkSize": null,
"linkWeight": null,
"logo": null,
"logoMark": null,
"newsletter": null,
"padding": null,
"phone": null,
"scheme": null,
"showBrandName": null,
"socialSize": null,
"socialStyle": null,
"status": null,
"width": null
},
"footerColumns": [
null
],
"footerDescription": "string",
"footerLinks": [
null
],
"headerLinks": [
null
],
"headerSpaceIds": [
null
],
"mobileNav": "bar",
"navMenu": {
"animation": null,
"background": null,
"border": null,
"closeDelay": null,
"ink": null,
"openDelay": null,
"radius": null,
"shadow": null,
"trigger": null,
"width": null
},
"pageMounts": [
null
],
"socialLinks": [
null
],
"tabs": [
null
],
"tagline": "string",
"theme": {},
"themeToggle": {
"activeColor": null,
"border": null,
"footerAlign": null,
"hideOn": null,
"modes": null,
"phone": null,
"position": null,
"radius": null,
"show": null,
"style": null
},
"translations": {}
},
"createdAt": "2024-01-01T00:00:00Z",
"id": "string",
"name": "string",
"slug": "string",
"spaceIds": [
"string"
],
"staging": true,
"stagingToken": "string"
},
"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"
}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