Update a project's schedule, modules, tracked keywords, or caps.
curl --request PATCH \
--url https://api.parallellabs.app/api/v0/seo/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"companyId": "<string>",
"name": "<string>",
"enabledModules": {},
"trackedKeywords": [
"<string>"
],
"competitorDomains": [
"<string>"
],
"trackedPrompts": [
"<string>"
],
"brandNames": [
"<string>"
],
"aiPlatforms": {},
"trackAiOverview": true,
"notificationUserIds": [
"<string>"
],
"backlinksMaxLinks": 123,
"auditMaxPages": 123,
"country": "<string>",
"language": "<string>",
"timezone": "<string>"
}
'import requests
url = "https://api.parallellabs.app/api/v0/seo/projects/{projectId}"
payload = {
"companyId": "<string>",
"name": "<string>",
"enabledModules": {},
"trackedKeywords": ["<string>"],
"competitorDomains": ["<string>"],
"trackedPrompts": ["<string>"],
"brandNames": ["<string>"],
"aiPlatforms": {},
"trackAiOverview": True,
"notificationUserIds": ["<string>"],
"backlinksMaxLinks": 123,
"auditMaxPages": 123,
"country": "<string>",
"language": "<string>",
"timezone": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyId: '<string>',
name: '<string>',
enabledModules: {},
trackedKeywords: ['<string>'],
competitorDomains: ['<string>'],
trackedPrompts: ['<string>'],
brandNames: ['<string>'],
aiPlatforms: {},
trackAiOverview: true,
notificationUserIds: ['<string>'],
backlinksMaxLinks: 123,
auditMaxPages: 123,
country: '<string>',
language: '<string>',
timezone: '<string>'
})
};
fetch('https://api.parallellabs.app/api/v0/seo/projects/{projectId}', 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.parallellabs.app/api/v0/seo/projects/{projectId}",
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([
'companyId' => '<string>',
'name' => '<string>',
'enabledModules' => [
],
'trackedKeywords' => [
'<string>'
],
'competitorDomains' => [
'<string>'
],
'trackedPrompts' => [
'<string>'
],
'brandNames' => [
'<string>'
],
'aiPlatforms' => [
],
'trackAiOverview' => true,
'notificationUserIds' => [
'<string>'
],
'backlinksMaxLinks' => 123,
'auditMaxPages' => 123,
'country' => '<string>',
'language' => '<string>',
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.parallellabs.app/api/v0/seo/projects/{projectId}"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"enabledModules\": {},\n \"trackedKeywords\": [\n \"<string>\"\n ],\n \"competitorDomains\": [\n \"<string>\"\n ],\n \"trackedPrompts\": [\n \"<string>\"\n ],\n \"brandNames\": [\n \"<string>\"\n ],\n \"aiPlatforms\": {},\n \"trackAiOverview\": true,\n \"notificationUserIds\": [\n \"<string>\"\n ],\n \"backlinksMaxLinks\": 123,\n \"auditMaxPages\": 123,\n \"country\": \"<string>\",\n \"language\": \"<string>\",\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.parallellabs.app/api/v0/seo/projects/{projectId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"enabledModules\": {},\n \"trackedKeywords\": [\n \"<string>\"\n ],\n \"competitorDomains\": [\n \"<string>\"\n ],\n \"trackedPrompts\": [\n \"<string>\"\n ],\n \"brandNames\": [\n \"<string>\"\n ],\n \"aiPlatforms\": {},\n \"trackAiOverview\": true,\n \"notificationUserIds\": [\n \"<string>\"\n ],\n \"backlinksMaxLinks\": 123,\n \"auditMaxPages\": 123,\n \"country\": \"<string>\",\n \"language\": \"<string>\",\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/seo/projects/{projectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"enabledModules\": {},\n \"trackedKeywords\": [\n \"<string>\"\n ],\n \"competitorDomains\": [\n \"<string>\"\n ],\n \"trackedPrompts\": [\n \"<string>\"\n ],\n \"brandNames\": [\n \"<string>\"\n ],\n \"aiPlatforms\": {},\n \"trackAiOverview\": true,\n \"notificationUserIds\": [\n \"<string>\"\n ],\n \"backlinksMaxLinks\": 123,\n \"auditMaxPages\": 123,\n \"country\": \"<string>\",\n \"language\": \"<string>\",\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"companyId": "<string>",
"domain": "<string>",
"name": "<string>",
"status": "active",
"frequency": "manual",
"timezone": "<string>",
"nextRunAt": "2023-11-07T05:31:56Z",
"lastRunAt": "2023-11-07T05:31:56Z",
"runCount": 123,
"enabledModules": {},
"trackedKeywords": [
"<string>"
],
"competitorDomains": [
"<string>"
],
"trackedPrompts": [
"<string>"
],
"brandNames": [
"<string>"
],
"aiPlatforms": {},
"trackAiOverview": true,
"notificationUserIds": [
"<string>"
],
"backlinksMaxLinks": 123,
"auditMaxPages": 123,
"country": "<string>",
"language": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"updated_date": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}SEO
Update a project's schedule, modules, tracked keywords, or caps.
PATCH
/
api
/
v0
/
seo
/
projects
/
{projectId}
Update a project's schedule, modules, tracked keywords, or caps.
curl --request PATCH \
--url https://api.parallellabs.app/api/v0/seo/projects/{projectId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"companyId": "<string>",
"name": "<string>",
"enabledModules": {},
"trackedKeywords": [
"<string>"
],
"competitorDomains": [
"<string>"
],
"trackedPrompts": [
"<string>"
],
"brandNames": [
"<string>"
],
"aiPlatforms": {},
"trackAiOverview": true,
"notificationUserIds": [
"<string>"
],
"backlinksMaxLinks": 123,
"auditMaxPages": 123,
"country": "<string>",
"language": "<string>",
"timezone": "<string>"
}
'import requests
url = "https://api.parallellabs.app/api/v0/seo/projects/{projectId}"
payload = {
"companyId": "<string>",
"name": "<string>",
"enabledModules": {},
"trackedKeywords": ["<string>"],
"competitorDomains": ["<string>"],
"trackedPrompts": ["<string>"],
"brandNames": ["<string>"],
"aiPlatforms": {},
"trackAiOverview": True,
"notificationUserIds": ["<string>"],
"backlinksMaxLinks": 123,
"auditMaxPages": 123,
"country": "<string>",
"language": "<string>",
"timezone": "<string>"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
companyId: '<string>',
name: '<string>',
enabledModules: {},
trackedKeywords: ['<string>'],
competitorDomains: ['<string>'],
trackedPrompts: ['<string>'],
brandNames: ['<string>'],
aiPlatforms: {},
trackAiOverview: true,
notificationUserIds: ['<string>'],
backlinksMaxLinks: 123,
auditMaxPages: 123,
country: '<string>',
language: '<string>',
timezone: '<string>'
})
};
fetch('https://api.parallellabs.app/api/v0/seo/projects/{projectId}', 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.parallellabs.app/api/v0/seo/projects/{projectId}",
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([
'companyId' => '<string>',
'name' => '<string>',
'enabledModules' => [
],
'trackedKeywords' => [
'<string>'
],
'competitorDomains' => [
'<string>'
],
'trackedPrompts' => [
'<string>'
],
'brandNames' => [
'<string>'
],
'aiPlatforms' => [
],
'trackAiOverview' => true,
'notificationUserIds' => [
'<string>'
],
'backlinksMaxLinks' => 123,
'auditMaxPages' => 123,
'country' => '<string>',
'language' => '<string>',
'timezone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$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.parallellabs.app/api/v0/seo/projects/{projectId}"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"enabledModules\": {},\n \"trackedKeywords\": [\n \"<string>\"\n ],\n \"competitorDomains\": [\n \"<string>\"\n ],\n \"trackedPrompts\": [\n \"<string>\"\n ],\n \"brandNames\": [\n \"<string>\"\n ],\n \"aiPlatforms\": {},\n \"trackAiOverview\": true,\n \"notificationUserIds\": [\n \"<string>\"\n ],\n \"backlinksMaxLinks\": 123,\n \"auditMaxPages\": 123,\n \"country\": \"<string>\",\n \"language\": \"<string>\",\n \"timezone\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
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.parallellabs.app/api/v0/seo/projects/{projectId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"enabledModules\": {},\n \"trackedKeywords\": [\n \"<string>\"\n ],\n \"competitorDomains\": [\n \"<string>\"\n ],\n \"trackedPrompts\": [\n \"<string>\"\n ],\n \"brandNames\": [\n \"<string>\"\n ],\n \"aiPlatforms\": {},\n \"trackAiOverview\": true,\n \"notificationUserIds\": [\n \"<string>\"\n ],\n \"backlinksMaxLinks\": 123,\n \"auditMaxPages\": 123,\n \"country\": \"<string>\",\n \"language\": \"<string>\",\n \"timezone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/seo/projects/{projectId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"companyId\": \"<string>\",\n \"name\": \"<string>\",\n \"enabledModules\": {},\n \"trackedKeywords\": [\n \"<string>\"\n ],\n \"competitorDomains\": [\n \"<string>\"\n ],\n \"trackedPrompts\": [\n \"<string>\"\n ],\n \"brandNames\": [\n \"<string>\"\n ],\n \"aiPlatforms\": {},\n \"trackAiOverview\": true,\n \"notificationUserIds\": [\n \"<string>\"\n ],\n \"backlinksMaxLinks\": 123,\n \"auditMaxPages\": 123,\n \"country\": \"<string>\",\n \"language\": \"<string>\",\n \"timezone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"companyId": "<string>",
"domain": "<string>",
"name": "<string>",
"status": "active",
"frequency": "manual",
"timezone": "<string>",
"nextRunAt": "2023-11-07T05:31:56Z",
"lastRunAt": "2023-11-07T05:31:56Z",
"runCount": 123,
"enabledModules": {},
"trackedKeywords": [
"<string>"
],
"competitorDomains": [
"<string>"
],
"trackedPrompts": [
"<string>"
],
"brandNames": [
"<string>"
],
"aiPlatforms": {},
"trackAiOverview": true,
"notificationUserIds": [
"<string>"
],
"backlinksMaxLinks": 123,
"auditMaxPages": 123,
"country": "<string>",
"language": "<string>",
"created_date": "2023-11-07T05:31:56Z",
"updated_date": "2023-11-07T05:31:56Z"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
CompanyApiKeyBearerAuth & CompanyId
Body
application/json
Fields to change
Change a monitored website's schedule, modules, keywords or caps
Response
The updated project
A monitored website. enabledModules maps each SEO/AEO module key to whether it runs on the schedule; any module can also be run on demand with seo_runProjectRoute.

