Change the site's settings. Theme values are validated against the token list

Before you call

Credential

Authorization: Bearer $KEY

Scope

hosting:write

Graphql

Mutation.hostingSettingsSave

Sdk

hosting.settings.save

Cli

hosting settings save

Parameters

• idstring (uuid)required
  In the path

Request bodyapplication/json, required

• namestring
  At most 120 characters.
• baseUrlstring or null
• apiBasestring
  At most 200 characters.
• publishableKeystring
  At most 200 characters.
• assetBasestring
  At most 200 characters.
• themeobject
• defaultLocalestring
  At most 20 characters.
• localeslist of string
• aiDisclosurestring
  At most 300 characters.
• organizationobject or null
• analyticsobject
  • modestringrequired
    One of: off, cookieless, consent.
• localePathsstring
  One of: prefix-except-default, prefix.
• surfacestring
  One of: website, app, both.
• collectionslist of object
  • idstringrequired
    Pattern: ^[a-z][a-z0-9-]{1,39}$.
  • slugstringrequired
    Pattern: ^[a-z0-9][a-z0-9-]{0,59}$.
  • titlestringrequired
    At most 100 characters.
  • descriptionstring
    Default: . At most 400 characters.
  • projectIdslist of string (uuid)
    Default: [].
• approvalsobject or null
• pwaobject
  • enabledbooleanrequired
  • namestringrequired
    At most 60 characters.
  • shortNamestringrequired
    At most 14 characters.
  • themeColorstringrequired
    At most 7 characters.
  • backgroundColorstringrequired
    At most 7 characters.
  • displaystringrequired
    One of: standalone, minimal-ui, browser.
  • startPathstringrequired
    At most 120 characters.
  • iconAssetId192string (uuid)
  • iconAssetId512string (uuid)
• redirectslist of object
  • fromstringrequired
    At most 120 characters.
  • tostringrequired
    At most 300 characters.
  • statusnumberrequired
    One of: 301, 302, 307, 308, 410.
• feedslist of object
  • pathstringrequired
    At most 60 characters.
  • formatstringrequired
    One of: rss, atom, json.
  • typestringrequired
    At most 40 characters.
  • titlestringrequired
    At most 120 characters.
  • limitinteger
    At least 1. At most 100.

Responses

• 200application/json
  Success
• 400application/json
  The request was malformed
  • errorstringrequired
  • messagestring
• 401application/json
  No valid credential
  • errorstringrequired
  • messagestring
• 403application/json
  The credential lacks the scope, origin or address
  • errorstringrequired
  • messagestring
• 429application/json
  Over the key's rate limit; see Retry-After
  • errorstringrequired
  • messagestring