latestOpenAPI 3.1.02026-08-1021368.3 KB

50679caad756

Sites

Update site

Update a site. Send only the fields you want to change.

Permissions: Requires write access to the site (manage:{site_id}).

Returns: A site object.

post/sites/{site_id}

Path parameters

site_idstring required
Example:CDBUGS

The ID of the site. This is the same string you use in your tracking code. Example: CDBUGS

Request body

namestring

The name of the website (up to 255 characters).

sharing'none' | 'private' | 'public'

The sharing configuration. Supported values are none, private or public.

share_passwordstring

When sharing is set to private, you must also send a password to access the site with (up to 255 characters).

Required if sharing is private.

timezonestring

The site's reporting timezone as a TZ database name (e.g. America/New_York). Reporting for this site will use this timezone.

multi_domainboolean

Set to true to allow this site to track multiple domains.

multi_domain_option'combined' | 'separate'

How multi-domain data is grouped: combined or separate.

Required if multi_domain is true.

Example request

{
  "name": "Acme Holdings Inc"
}

Response

Successful response