Update SEO Guidelines terms
curl --request PATCH \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"terms": [
{
"heading": true,
"included": true,
"item": "seo tools"
},
{
"included": false,
"item": "backlinks"
}
]
}
'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms"
payload = { "terms": [
{
"heading": True,
"included": True,
"item": "seo tools"
},
{
"included": False,
"item": "backlinks"
}
] }
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
terms: [
{heading: true, included: true, item: 'seo tools'},
{included: false, item: 'backlinks'}
]
})
};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms', 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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms",
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([
'terms' => [
[
'heading' => true,
'included' => true,
'item' => 'seo tools'
],
[
'included' => false,
'item' => 'backlinks'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms"
payload := strings.NewReader("{\n \"terms\": [\n {\n \"heading\": true,\n \"included\": true,\n \"item\": \"seo tools\"\n },\n {\n \"included\": false,\n \"item\": \"backlinks\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"terms\": [\n {\n \"heading\": true,\n \"included\": true,\n \"item\": \"seo tools\"\n },\n {\n \"included\": false,\n \"item\": \"backlinks\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"terms\": [\n {\n \"heading\": true,\n \"included\": true,\n \"item\": \"seo tools\"\n },\n {\n \"included\": false,\n \"item\": \"backlinks\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"heading": true,
"included": true,
"item": "seo tools",
"target_range": {
"max": 9,
"min": 5
}
},
{
"heading": false,
"included": true,
"item": "keyword research",
"target_range": {
"max": 7,
"min": 3
}
},
{
"heading": false,
"included": false,
"item": "backlinks",
"target_range": null
}
],
"meta": {
"total": 3
}
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [],
"message": "The request conflicts with the current resource state.",
"reason": "conflict"
}
}{
"error": {
"details": [],
"message": "Set Content-Type: application/json.",
"reason": "unsupported_media_type"
}
}{
"error": {
"details": [],
"message": "The request was understood but could not be processed.",
"reason": "unprocessable_entity"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}SEO Guidelines
Update SEO Guidelines terms
Sets included and heading for each listed term. Terms not in the prominent or custom list are
created as custom terms; returns 400 too_many if custom terms would exceed 500. Requires the editor
to be in completed state.
Rate limit: 10 requests/sec
PATCH
/
api
/
v2
/
workspaces
/
{workspace_id}
/
content_editors
/
{content_editor_id}
/
seo_guidelines
/
terms
Update SEO Guidelines terms
curl --request PATCH \
--url https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms \
--header 'API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"terms": [
{
"heading": true,
"included": true,
"item": "seo tools"
},
{
"included": false,
"item": "backlinks"
}
]
}
'import requests
url = "https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms"
payload = { "terms": [
{
"heading": True,
"included": True,
"item": "seo tools"
},
{
"included": False,
"item": "backlinks"
}
] }
headers = {
"API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
terms: [
{heading: true, included: true, item: 'seo tools'},
{included: false, item: 'backlinks'}
]
})
};
fetch('https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms', 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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms",
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([
'terms' => [
[
'heading' => true,
'included' => true,
'item' => 'seo tools'
],
[
'included' => false,
'item' => 'backlinks'
]
]
]),
CURLOPT_HTTPHEADER => [
"API-KEY: <api-key>",
"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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms"
payload := strings.NewReader("{\n \"terms\": [\n {\n \"heading\": true,\n \"included\": true,\n \"item\": \"seo tools\"\n },\n {\n \"included\": false,\n \"item\": \"backlinks\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("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://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms")
.header("API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"terms\": [\n {\n \"heading\": true,\n \"included\": true,\n \"item\": \"seo tools\"\n },\n {\n \"included\": false,\n \"item\": \"backlinks\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.surferseo.com/api/v2/workspaces/{workspace_id}/content_editors/{content_editor_id}/seo_guidelines/terms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"terms\": [\n {\n \"heading\": true,\n \"included\": true,\n \"item\": \"seo tools\"\n },\n {\n \"included\": false,\n \"item\": \"backlinks\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"heading": true,
"included": true,
"item": "seo tools",
"target_range": {
"max": 9,
"min": 5
}
},
{
"heading": false,
"included": true,
"item": "keyword research",
"target_range": {
"max": 7,
"min": 3
}
},
{
"heading": false,
"included": false,
"item": "backlinks",
"target_range": null
}
],
"meta": {
"total": 3
}
}{
"error": {
"details": [
{
"field": "keywords",
"reason": "required"
}
],
"reason": "validation_error"
}
}{
"error": {
"details": [],
"reason": "unauthorized"
}
}{
"error": {
"details": [],
"reason": "permission_denied"
}
}{
"error": {
"details": [],
"reason": "not_found"
}
}{
"error": {
"details": [
{
"allowed": [
"application/json"
],
"field": "accept",
"reason": "unsupported"
}
],
"message": "Accept must be one of: application/json",
"reason": "not_acceptable"
}
}{
"error": {
"details": [],
"message": "The request conflicts with the current resource state.",
"reason": "conflict"
}
}{
"error": {
"details": [],
"message": "Set Content-Type: application/json.",
"reason": "unsupported_media_type"
}
}{
"error": {
"details": [],
"message": "The request was understood but could not be processed.",
"reason": "unprocessable_entity"
}
}{
"error": {
"details": [
{
"retry_after": 30
}
],
"reason": "rate_limit_exceeded"
}
}Authorizations
Path Parameters
Required range:
x >= 1Example:
123
Required range:
x >= 1Example:
123
Body
application/json
Term updates
Minimum array length:
1Show child attributes
Show child attributes
Was this page helpful?