Create project
Create a project without enabling tracking schedules or automatic email.
/projectsprojects:writeAn unrestricted account key owned by a current account Admin is required.
Authentication and permissions · Errors and limitsAuthorization
Authorizationstring · headerRequiredBearer access key. Never put a key in the URL.
Idempotency-Keystring · headerRequiredRequired for creation: 1–128 letters, numbers, dots, underscores, colons or hyphens. Reuse for retries of the same request within 24 hours.
Request body
application/json. Unknown fields are rejected.
namestringRequiredProject name: 1–100 characters.
workspaceIdstringRequiredActive workspace in this account.
domainstringRequiredPublic website domain, up to 500 characters; no credentials or port.
websiteUrlstring | nullOptionalOptional HTTP(S) URL on the project domain, up to 2,000 characters.
marketstringRequiredSupported country code.
languagestringRequiredSupported language code.
targetStatestring | nullOptionalSupported two-letter US state, or null for all states.
brandAliasesstring[]OptionalUp to 30 additional names, each 1–200 characters.
domainAliasesstring[]OptionalUp to 30 public website domains.
includeSubdomainsbooleanOptionalInclude subdomains in website matching.
Response fields
dataobjectRequiredCreate a project without enabling tracking schedules or automatic email.
Child fields
idstringRequiredProject identifier.
workspaceIdstringRequiredOwning workspace.
namestringRequiredProject name.
domainstringRequiredPrimary website domain.
websiteUrlstring | nullRequiredWebsite scope URL.
marketstringRequiredCountry code.
targetStatestring | nullRequiredUS state code, if selected.
languagestringRequiredLanguage code.
brandAliasesstring[]RequiredAdditional brand names.
domainAliasesstring[]RequiredAdditional website domains.
includeSubdomainsbooleanRequiredWhether subdomains are included.
archivedbooleanRequiredWhether the project is archived.
createdAtISO 8601 timestampRequiredWhen the project was created.
metaobjectRequiredRequest metadata. Present on JSON success responses.
Child fields
requestIdstringRequiredRequest identifier to include when contacting support.
resultScope"saved"RequiredSaved customer information; excludes Overview preview results.