Show examples in:
Update the site's settings

Body Parameters

no_index  Optional  boolean  Example: true

Whether the website needs to be indexed by search engines or not

favicon  Optional  string, null  Example: "123"

The upload id for the favicon

global_seo  Optional  object, null

Specifies default global settings

name  Optional  string  Example: "My Awesome Website"

Site name

theme  Optional  
locales  Optional  Array<string>  Example: ["en"]

Available locales

timezone  Optional  string  Example: "Europe/London"

Site default timezone

require_2fa  Optional  boolean

Specifies whether all users of this site need to authenticate using two-factor authentication

ip_tracking_enabled  Optional  boolean  Example: true

Specifies whether you want IPs to be tracked in the Project usages section

force_use_of_sandbox_environments  Optional  boolean  Example: true

If enabled, blocks schema changes of primary environment

meta.improved_timezone_management  Optional  boolean  Example: true

Whether the Improved API Timezone Management option is active or not

meta.improved_hex_management  Optional  boolean  Example: true

Whether the Improved API Hex Management option is active or not

meta.improved_gql_multilocale_fields  Optional  boolean  Example: true

Whether the Improved GraphQL multi-locale fields option is active or not

meta.improved_gql_visibility_control  Optional  boolean  Example: true

Whether the Improved GraphQL visibility control option is active or not

meta.improved_boolean_fields  Optional  boolean  Example: true

Whether the Improved boolean fields option is active or not

meta.custom_upload_storage_settings  Optional  boolean  Example: true

Whether the site has custom upload storage settings

sso_default_role  Optional  { type: "role", id: role.id }

Returns

Returns a site resource object.

Examples

Example Basic example
import { buildClient } from '@datocms/cma-client-node';
async function run() {
const client = buildClient({ apiToken: '<YOUR_API_TOKEN>' });
const site = await client.site.update({});
console.log(site);
}
run();