Update the tags or note on a keyword.
curl --request PATCH \
--url https://api.parallellabs.app/api/v0/seo/keywords/{keywordId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"companyId": "<string>",
"tags": [
"<string>"
],
"notes": "<string>"
}
'import requests
url = "https://api.parallellabs.app/api/v0/seo/keywords/{keywordId}"
payload = {
"companyId": "<string>",
"tags": ["<string>"],
"notes": "<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>', tags: ['<string>'], notes: '<string>'})
};
fetch('https://api.parallellabs.app/api/v0/seo/keywords/{keywordId}', 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/keywords/{keywordId}",
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>',
'tags' => [
'<string>'
],
'notes' => '<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/keywords/{keywordId}"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<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/keywords/{keywordId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/seo/keywords/{keywordId}")
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 \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"keyword": {
"id": "<string>",
"keyword": "<string>",
"country": "<string>",
"language": "<string>",
"saved": true,
"savedAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"notes": "<string>",
"metrics": {
"keyword": "<string>",
"volume": 123,
"volumeSource": "<string>",
"cpc": 123,
"competition": "<string>",
"competitionIndex": 123,
"monthlySearches": [
{}
],
"trend": "<string>",
"momChangePct": 123,
"saved": true,
"isSeed": true,
"fetchedAt": "2023-11-07T05:31:56Z"
},
"created_date": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}SEO
Update the tags or note on a keyword.
PATCH
/
api
/
v0
/
seo
/
keywords
/
{keywordId}
Update the tags or note on a keyword.
curl --request PATCH \
--url https://api.parallellabs.app/api/v0/seo/keywords/{keywordId} \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"companyId": "<string>",
"tags": [
"<string>"
],
"notes": "<string>"
}
'import requests
url = "https://api.parallellabs.app/api/v0/seo/keywords/{keywordId}"
payload = {
"companyId": "<string>",
"tags": ["<string>"],
"notes": "<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>', tags: ['<string>'], notes: '<string>'})
};
fetch('https://api.parallellabs.app/api/v0/seo/keywords/{keywordId}', 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/keywords/{keywordId}",
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>',
'tags' => [
'<string>'
],
'notes' => '<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/keywords/{keywordId}"
payload := strings.NewReader("{\n \"companyId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<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/keywords/{keywordId}")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"companyId\": \"<string>\",\n \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.parallellabs.app/api/v0/seo/keywords/{keywordId}")
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 \"tags\": [\n \"<string>\"\n ],\n \"notes\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"keyword": {
"id": "<string>",
"keyword": "<string>",
"country": "<string>",
"language": "<string>",
"saved": true,
"savedAt": "2023-11-07T05:31:56Z",
"tags": [
"<string>"
],
"notes": "<string>",
"metrics": {
"keyword": "<string>",
"volume": 123,
"volumeSource": "<string>",
"cpc": 123,
"competition": "<string>",
"competitionIndex": 123,
"monthlySearches": [
{}
],
"trend": "<string>",
"momChangePct": 123,
"saved": true,
"isSeed": true,
"fetchedAt": "2023-11-07T05:31:56Z"
},
"created_date": "2023-11-07T05:31:56Z"
}
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}{
"error": "<string>"
}Authorizations
CompanyApiKeyBearerAuth & CompanyId
Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.
Path Parameters
Body
application/json
Fields to update
Response
The updated keyword
The keyword
A keyword and its metrics. Rows are created when a research run or a manual lookup harvests the keyword, so everything the company has paid to discover is listed. saved records whether a user explicitly kept it.
Show child attributes
Show child attributes
⌘I

