Skip to main content
PATCH
Replace a project's GEO settings

Authorizations

Authorization
string
header
required

Send your API key in the Authorization header as Bearer API_KEY. Account API keys work in every workspace you belong to: send X-Notra-Organization-Id with the workspace id or slug to choose one. Workspace endpoints require it when you belong to more than one workspace; GET /v1/me/workspaces works without it. Organization keys only accept their own workspace there.

Path Parameters

projectId
string
required
Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]{1,100}$
Example:

"b1f2c3d4-0000-4000-8000-000000000000"

Body

application/json
companyName
string
required
Required string length: 1 - 128
aliases
string[]
required
Maximum array length: 10
Required string length: 1 - 128
languages
string[]
required
Required array length: 1 - 4 elements
Required string length: 1 - 128
engines
string[]
required
Required array length: 1 - 64 elements
Required string length: 1 - 128
enforceZdr
boolean
required
nonZdrApprovedEngines
string[]
required
Maximum array length: 64
Required string length: 1 - 128
enabled
boolean
required
scanIntervalHours
integer
required

Hours between automatic scans, 24-2160, in whole days (multiple of 24). Presets: 24, 48, 72, 168, 336, 720.

Required range: 24 <= x <= 2160
conversionPaths
string[]

Paths that count as a conversion when an AI referral reaches them. Prefix match. Omit to keep the stored list.

Maximum array length: 20
Required string length: 1 - 200
domains
string[]

Additional hostnames that send AI traffic to this project, besides the brand website. Subdomains of a listed domain are included. Omit to keep the stored list.

Maximum array length: 20
Required string length: 1 - 128

Also scan search-capable models without web search. Omit to keep the stored value (default false).

pausedAutoPromptIds
string[]

Ids of auto-generated prompts to skip in scans. Omit to keep the current list.

Maximum array length: 8
Required string length: 1 - 128
removedAutoPromptIds
string[]

Ids of auto-generated prompts removed from tracking. Omit to keep the current list.

Maximum array length: 8
Required string length: 1 - 128

Response

Settings updated successfully

configured
boolean
required

Whether the analytics store behind AI traffic and web analytics is set up on this Notra deployment. It does not depend on the project or its settings.

settings
object | null
required

Null when the project has no saved GEO settings yet. Save them with PATCH /v1/projects/{projectId}/geo/settings.

organization
object
required