curl --request PATCH \
--url https://api.usenotra.com/v1/projects/{projectId}/geo/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"companyName": "<string>",
"aliases": [
"<string>"
],
"languages": [
"<string>"
],
"engines": [
"<string>"
],
"enforceZdr": true,
"nonZdrApprovedEngines": [
"<string>"
],
"enabled": true,
"scanIntervalHours": 1092,
"conversionPaths": [
"<string>"
],
"domains": [
"<string>"
],
"trackWithoutSearch": true,
"pausedAutoPromptIds": [
"<string>"
],
"removedAutoPromptIds": [
"<string>"
]
}
'import requests
url = "https://api.usenotra.com/v1/projects/{projectId}/geo/settings"
payload = {
"companyName": "<string>",
"aliases": ["<string>"],
"languages": ["<string>"],
"engines": ["<string>"],
"enforceZdr": True,
"nonZdrApprovedEngines": ["<string>"],
"enabled": True,
"scanIntervalHours": 1092,
"conversionPaths": ["<string>"],
"domains": ["<string>"],
"trackWithoutSearch": True,
"pausedAutoPromptIds": ["<string>"],
"removedAutoPromptIds": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyName: '<string>',
aliases: ['<string>'],
languages: ['<string>'],
engines: ['<string>'],
enforceZdr: true,
nonZdrApprovedEngines: ['<string>'],
enabled: true,
scanIntervalHours: 1092,
conversionPaths: ['<string>'],
domains: ['<string>'],
trackWithoutSearch: true,
pausedAutoPromptIds: ['<string>'],
removedAutoPromptIds: ['<string>']
})
};
fetch('https://api.usenotra.com/v1/projects/{projectId}/geo/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.usenotra.com/v1/projects/{projectId}/geo/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyName' => '<string>',
'aliases' => [
'<string>'
],
'languages' => [
'<string>'
],
'engines' => [
'<string>'
],
'enforceZdr' => true,
'nonZdrApprovedEngines' => [
'<string>'
],
'enabled' => true,
'scanIntervalHours' => 1092,
'conversionPaths' => [
'<string>'
],
'domains' => [
'<string>'
],
'trackWithoutSearch' => true,
'pausedAutoPromptIds' => [
'<string>'
],
'removedAutoPromptIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usenotra.com/v1/projects/{projectId}/geo/settings"
payload := strings.NewReader("{\n \"companyName\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"engines\": [\n \"<string>\"\n ],\n \"enforceZdr\": true,\n \"nonZdrApprovedEngines\": [\n \"<string>\"\n ],\n \"enabled\": true,\n \"scanIntervalHours\": 1092,\n \"conversionPaths\": [\n \"<string>\"\n ],\n \"domains\": [\n \"<string>\"\n ],\n \"trackWithoutSearch\": true,\n \"pausedAutoPromptIds\": [\n \"<string>\"\n ],\n \"removedAutoPromptIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.usenotra.com/v1/projects/{projectId}/geo/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"engines\": [\n \"<string>\"\n ],\n \"enforceZdr\": true,\n \"nonZdrApprovedEngines\": [\n \"<string>\"\n ],\n \"enabled\": true,\n \"scanIntervalHours\": 1092,\n \"conversionPaths\": [\n \"<string>\"\n ],\n \"domains\": [\n \"<string>\"\n ],\n \"trackWithoutSearch\": true,\n \"pausedAutoPromptIds\": [\n \"<string>\"\n ],\n \"removedAutoPromptIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenotra.com/v1/projects/{projectId}/geo/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyName\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"engines\": [\n \"<string>\"\n ],\n \"enforceZdr\": true,\n \"nonZdrApprovedEngines\": [\n \"<string>\"\n ],\n \"enabled\": true,\n \"scanIntervalHours\": 1092,\n \"conversionPaths\": [\n \"<string>\"\n ],\n \"domains\": [\n \"<string>\"\n ],\n \"trackWithoutSearch\": true,\n \"pausedAutoPromptIds\": [\n \"<string>\"\n ],\n \"removedAutoPromptIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"configured": true,
"settings": {
"id": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"companyName": "<string>",
"aliases": [
"<string>"
],
"conversionPaths": [
"<string>"
],
"domains": [
"<string>"
],
"competitors": [
"<string>"
],
"languages": [
"<string>"
],
"engines": [
"<string>"
],
"enforceZdr": true,
"nonZdrApprovedEngines": [
"<string>"
],
"trackWithoutSearch": true,
"pausedAutoPromptIds": [
"<string>"
],
"removedAutoPromptIds": [
"<string>"
],
"enabled": true,
"scanIntervalHours": 123,
"scanStartedAt": "<string>",
"lastScanAt": "<string>",
"isScanning": true,
"createdAt": "<string>",
"updatedAt": "<string>"
},
"organization": {
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"logo": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}Replace a project's GEO settings
Writes the full settings document and re-arms the recurring scan. Engines must be ids returned by GET /projects/{projectId}/geo/engines (model APIs plus consumer surfaces such as google/ai-overview, google/gemini and openai/chatgpt) and languages must be supported languages; an unknown value is rejected with a 400 instead of being replaced by a default. Zero data retention is forced off without the ZDR add-on, and engines that are not visible to this caller keep their stored selection. Competitors are managed through the competitors endpoints and are not part of this payload. The language the project’s prompts are written in always stays tracked: leaving it out of languages adds it back as the first entry, and a full list without it is rejected with a 400.
curl --request PATCH \
--url https://api.usenotra.com/v1/projects/{projectId}/geo/settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"companyName": "<string>",
"aliases": [
"<string>"
],
"languages": [
"<string>"
],
"engines": [
"<string>"
],
"enforceZdr": true,
"nonZdrApprovedEngines": [
"<string>"
],
"enabled": true,
"scanIntervalHours": 1092,
"conversionPaths": [
"<string>"
],
"domains": [
"<string>"
],
"trackWithoutSearch": true,
"pausedAutoPromptIds": [
"<string>"
],
"removedAutoPromptIds": [
"<string>"
]
}
'import requests
url = "https://api.usenotra.com/v1/projects/{projectId}/geo/settings"
payload = {
"companyName": "<string>",
"aliases": ["<string>"],
"languages": ["<string>"],
"engines": ["<string>"],
"enforceZdr": True,
"nonZdrApprovedEngines": ["<string>"],
"enabled": True,
"scanIntervalHours": 1092,
"conversionPaths": ["<string>"],
"domains": ["<string>"],
"trackWithoutSearch": True,
"pausedAutoPromptIds": ["<string>"],
"removedAutoPromptIds": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyName: '<string>',
aliases: ['<string>'],
languages: ['<string>'],
engines: ['<string>'],
enforceZdr: true,
nonZdrApprovedEngines: ['<string>'],
enabled: true,
scanIntervalHours: 1092,
conversionPaths: ['<string>'],
domains: ['<string>'],
trackWithoutSearch: true,
pausedAutoPromptIds: ['<string>'],
removedAutoPromptIds: ['<string>']
})
};
fetch('https://api.usenotra.com/v1/projects/{projectId}/geo/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.usenotra.com/v1/projects/{projectId}/geo/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'companyName' => '<string>',
'aliases' => [
'<string>'
],
'languages' => [
'<string>'
],
'engines' => [
'<string>'
],
'enforceZdr' => true,
'nonZdrApprovedEngines' => [
'<string>'
],
'enabled' => true,
'scanIntervalHours' => 1092,
'conversionPaths' => [
'<string>'
],
'domains' => [
'<string>'
],
'trackWithoutSearch' => true,
'pausedAutoPromptIds' => [
'<string>'
],
'removedAutoPromptIds' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.usenotra.com/v1/projects/{projectId}/geo/settings"
payload := strings.NewReader("{\n \"companyName\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"engines\": [\n \"<string>\"\n ],\n \"enforceZdr\": true,\n \"nonZdrApprovedEngines\": [\n \"<string>\"\n ],\n \"enabled\": true,\n \"scanIntervalHours\": 1092,\n \"conversionPaths\": [\n \"<string>\"\n ],\n \"domains\": [\n \"<string>\"\n ],\n \"trackWithoutSearch\": true,\n \"pausedAutoPromptIds\": [\n \"<string>\"\n ],\n \"removedAutoPromptIds\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.usenotra.com/v1/projects/{projectId}/geo/settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"companyName\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"engines\": [\n \"<string>\"\n ],\n \"enforceZdr\": true,\n \"nonZdrApprovedEngines\": [\n \"<string>\"\n ],\n \"enabled\": true,\n \"scanIntervalHours\": 1092,\n \"conversionPaths\": [\n \"<string>\"\n ],\n \"domains\": [\n \"<string>\"\n ],\n \"trackWithoutSearch\": true,\n \"pausedAutoPromptIds\": [\n \"<string>\"\n ],\n \"removedAutoPromptIds\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.usenotra.com/v1/projects/{projectId}/geo/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyName\": \"<string>\",\n \"aliases\": [\n \"<string>\"\n ],\n \"languages\": [\n \"<string>\"\n ],\n \"engines\": [\n \"<string>\"\n ],\n \"enforceZdr\": true,\n \"nonZdrApprovedEngines\": [\n \"<string>\"\n ],\n \"enabled\": true,\n \"scanIntervalHours\": 1092,\n \"conversionPaths\": [\n \"<string>\"\n ],\n \"domains\": [\n \"<string>\"\n ],\n \"trackWithoutSearch\": true,\n \"pausedAutoPromptIds\": [\n \"<string>\"\n ],\n \"removedAutoPromptIds\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"configured": true,
"settings": {
"id": "<string>",
"organizationId": "<string>",
"projectId": "<string>",
"companyName": "<string>",
"aliases": [
"<string>"
],
"conversionPaths": [
"<string>"
],
"domains": [
"<string>"
],
"competitors": [
"<string>"
],
"languages": [
"<string>"
],
"engines": [
"<string>"
],
"enforceZdr": true,
"nonZdrApprovedEngines": [
"<string>"
],
"trackWithoutSearch": true,
"pausedAutoPromptIds": [
"<string>"
],
"removedAutoPromptIds": [
"<string>"
],
"enabled": true,
"scanIntervalHours": 123,
"scanStartedAt": "<string>",
"lastScanAt": "<string>",
"isScanning": true,
"createdAt": "<string>",
"updatedAt": "<string>"
},
"organization": {
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"logo": "<string>"
}
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}{
"error": "<string>",
"code": "<string>",
"recovery": "<string>"
}Authorizations
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
Body
Response
Settings updated successfully
Was this page helpful?