curl --request PATCH \
--url https://api.snowseo.com/v3/settings/article-automation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"automation": true,
"postingFrequency": "<string>",
"preferredPostingTime": "<string>",
"timeZone": "<string>",
"preferredTopicIds": [
"<string>"
],
"preferredArticleTypes": [
"<string>"
],
"preferredCMSProvider": "<string>",
"writingLanguage": "<string>",
"useHumanizer": true,
"optionalSections": {
"faq": true,
"conclusion": true,
"cta": true,
"tldr": true,
"videos": true
},
"contentTone": [
"<string>"
],
"defaultImageProvider": "<string>",
"featuredImageStyles": [
"<string>"
],
"inArticleImageStyles": [
"<string>"
],
"customFeaturedImageReferenceUrl": "<string>",
"featuredImageText": true,
"featuredImageIncludeBrandColors": true,
"featuredImageIncludeBrandLogo": true,
"internalLinkVolume": 123,
"keepTableOfContents": true,
"autoUpdateExistingArticles": true,
"articleUpdateFrequency": "<string>",
"articleUpdateMinAgeDays": 123,
"authors": [
{
"name": "<string>",
"avatar": "<string>",
"url": "<string>",
"isDefault": true,
"cmsUsers": {
"wordpress": {
"id": "<string>",
"name": "<string>"
},
"ghost": {
"id": "<string>",
"name": "<string>"
}
}
}
]
}
'import requests
url = "https://api.snowseo.com/v3/settings/article-automation"
payload = {
"teamId": "<string>",
"automation": True,
"postingFrequency": "<string>",
"preferredPostingTime": "<string>",
"timeZone": "<string>",
"preferredTopicIds": ["<string>"],
"preferredArticleTypes": ["<string>"],
"preferredCMSProvider": "<string>",
"writingLanguage": "<string>",
"useHumanizer": True,
"optionalSections": {
"faq": True,
"conclusion": True,
"cta": True,
"tldr": True,
"videos": True
},
"contentTone": ["<string>"],
"defaultImageProvider": "<string>",
"featuredImageStyles": ["<string>"],
"inArticleImageStyles": ["<string>"],
"customFeaturedImageReferenceUrl": "<string>",
"featuredImageText": True,
"featuredImageIncludeBrandColors": True,
"featuredImageIncludeBrandLogo": True,
"internalLinkVolume": 123,
"keepTableOfContents": True,
"autoUpdateExistingArticles": True,
"articleUpdateFrequency": "<string>",
"articleUpdateMinAgeDays": 123,
"authors": [
{
"name": "<string>",
"avatar": "<string>",
"url": "<string>",
"isDefault": True,
"cmsUsers": {
"wordpress": {
"id": "<string>",
"name": "<string>"
},
"ghost": {
"id": "<string>",
"name": "<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({
teamId: '<string>',
automation: true,
postingFrequency: '<string>',
preferredPostingTime: '<string>',
timeZone: '<string>',
preferredTopicIds: ['<string>'],
preferredArticleTypes: ['<string>'],
preferredCMSProvider: '<string>',
writingLanguage: '<string>',
useHumanizer: true,
optionalSections: {faq: true, conclusion: true, cta: true, tldr: true, videos: true},
contentTone: ['<string>'],
defaultImageProvider: '<string>',
featuredImageStyles: ['<string>'],
inArticleImageStyles: ['<string>'],
customFeaturedImageReferenceUrl: '<string>',
featuredImageText: true,
featuredImageIncludeBrandColors: true,
featuredImageIncludeBrandLogo: true,
internalLinkVolume: 123,
keepTableOfContents: true,
autoUpdateExistingArticles: true,
articleUpdateFrequency: '<string>',
articleUpdateMinAgeDays: 123,
authors: [
{
name: '<string>',
avatar: '<string>',
url: '<string>',
isDefault: true,
cmsUsers: {
wordpress: {id: '<string>', name: '<string>'},
ghost: {id: '<string>', name: '<string>'}
}
}
]
})
};
fetch('https://api.snowseo.com/v3/settings/article-automation', 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.snowseo.com/v3/settings/article-automation",
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([
'teamId' => '<string>',
'automation' => true,
'postingFrequency' => '<string>',
'preferredPostingTime' => '<string>',
'timeZone' => '<string>',
'preferredTopicIds' => [
'<string>'
],
'preferredArticleTypes' => [
'<string>'
],
'preferredCMSProvider' => '<string>',
'writingLanguage' => '<string>',
'useHumanizer' => true,
'optionalSections' => [
'faq' => true,
'conclusion' => true,
'cta' => true,
'tldr' => true,
'videos' => true
],
'contentTone' => [
'<string>'
],
'defaultImageProvider' => '<string>',
'featuredImageStyles' => [
'<string>'
],
'inArticleImageStyles' => [
'<string>'
],
'customFeaturedImageReferenceUrl' => '<string>',
'featuredImageText' => true,
'featuredImageIncludeBrandColors' => true,
'featuredImageIncludeBrandLogo' => true,
'internalLinkVolume' => 123,
'keepTableOfContents' => true,
'autoUpdateExistingArticles' => true,
'articleUpdateFrequency' => '<string>',
'articleUpdateMinAgeDays' => 123,
'authors' => [
[
'name' => '<string>',
'avatar' => '<string>',
'url' => '<string>',
'isDefault' => true,
'cmsUsers' => [
'wordpress' => [
'id' => '<string>',
'name' => '<string>'
],
'ghost' => [
'id' => '<string>',
'name' => '<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.snowseo.com/v3/settings/article-automation"
payload := strings.NewReader("{\n \"teamId\": \"<string>\",\n \"automation\": true,\n \"postingFrequency\": \"<string>\",\n \"preferredPostingTime\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"preferredTopicIds\": [\n \"<string>\"\n ],\n \"preferredArticleTypes\": [\n \"<string>\"\n ],\n \"preferredCMSProvider\": \"<string>\",\n \"writingLanguage\": \"<string>\",\n \"useHumanizer\": true,\n \"optionalSections\": {\n \"faq\": true,\n \"conclusion\": true,\n \"cta\": true,\n \"tldr\": true,\n \"videos\": true\n },\n \"contentTone\": [\n \"<string>\"\n ],\n \"defaultImageProvider\": \"<string>\",\n \"featuredImageStyles\": [\n \"<string>\"\n ],\n \"inArticleImageStyles\": [\n \"<string>\"\n ],\n \"customFeaturedImageReferenceUrl\": \"<string>\",\n \"featuredImageText\": true,\n \"featuredImageIncludeBrandColors\": true,\n \"featuredImageIncludeBrandLogo\": true,\n \"internalLinkVolume\": 123,\n \"keepTableOfContents\": true,\n \"autoUpdateExistingArticles\": true,\n \"articleUpdateFrequency\": \"<string>\",\n \"articleUpdateMinAgeDays\": 123,\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"url\": \"<string>\",\n \"isDefault\": true,\n \"cmsUsers\": {\n \"wordpress\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"ghost\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n }\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.snowseo.com/v3/settings/article-automation")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"<string>\",\n \"automation\": true,\n \"postingFrequency\": \"<string>\",\n \"preferredPostingTime\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"preferredTopicIds\": [\n \"<string>\"\n ],\n \"preferredArticleTypes\": [\n \"<string>\"\n ],\n \"preferredCMSProvider\": \"<string>\",\n \"writingLanguage\": \"<string>\",\n \"useHumanizer\": true,\n \"optionalSections\": {\n \"faq\": true,\n \"conclusion\": true,\n \"cta\": true,\n \"tldr\": true,\n \"videos\": true\n },\n \"contentTone\": [\n \"<string>\"\n ],\n \"defaultImageProvider\": \"<string>\",\n \"featuredImageStyles\": [\n \"<string>\"\n ],\n \"inArticleImageStyles\": [\n \"<string>\"\n ],\n \"customFeaturedImageReferenceUrl\": \"<string>\",\n \"featuredImageText\": true,\n \"featuredImageIncludeBrandColors\": true,\n \"featuredImageIncludeBrandLogo\": true,\n \"internalLinkVolume\": 123,\n \"keepTableOfContents\": true,\n \"autoUpdateExistingArticles\": true,\n \"articleUpdateFrequency\": \"<string>\",\n \"articleUpdateMinAgeDays\": 123,\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"url\": \"<string>\",\n \"isDefault\": true,\n \"cmsUsers\": {\n \"wordpress\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"ghost\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/article-automation")
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 \"teamId\": \"<string>\",\n \"automation\": true,\n \"postingFrequency\": \"<string>\",\n \"preferredPostingTime\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"preferredTopicIds\": [\n \"<string>\"\n ],\n \"preferredArticleTypes\": [\n \"<string>\"\n ],\n \"preferredCMSProvider\": \"<string>\",\n \"writingLanguage\": \"<string>\",\n \"useHumanizer\": true,\n \"optionalSections\": {\n \"faq\": true,\n \"conclusion\": true,\n \"cta\": true,\n \"tldr\": true,\n \"videos\": true\n },\n \"contentTone\": [\n \"<string>\"\n ],\n \"defaultImageProvider\": \"<string>\",\n \"featuredImageStyles\": [\n \"<string>\"\n ],\n \"inArticleImageStyles\": [\n \"<string>\"\n ],\n \"customFeaturedImageReferenceUrl\": \"<string>\",\n \"featuredImageText\": true,\n \"featuredImageIncludeBrandColors\": true,\n \"featuredImageIncludeBrandLogo\": true,\n \"internalLinkVolume\": 123,\n \"keepTableOfContents\": true,\n \"autoUpdateExistingArticles\": true,\n \"articleUpdateFrequency\": \"<string>\",\n \"articleUpdateMinAgeDays\": 123,\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"url\": \"<string>\",\n \"isDefault\": true,\n \"cmsUsers\": {\n \"wordpress\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"ghost\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>"
}Update Article Automation
Update a brand’s article automation settings.
curl --request PATCH \
--url https://api.snowseo.com/v3/settings/article-automation \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"teamId": "<string>",
"automation": true,
"postingFrequency": "<string>",
"preferredPostingTime": "<string>",
"timeZone": "<string>",
"preferredTopicIds": [
"<string>"
],
"preferredArticleTypes": [
"<string>"
],
"preferredCMSProvider": "<string>",
"writingLanguage": "<string>",
"useHumanizer": true,
"optionalSections": {
"faq": true,
"conclusion": true,
"cta": true,
"tldr": true,
"videos": true
},
"contentTone": [
"<string>"
],
"defaultImageProvider": "<string>",
"featuredImageStyles": [
"<string>"
],
"inArticleImageStyles": [
"<string>"
],
"customFeaturedImageReferenceUrl": "<string>",
"featuredImageText": true,
"featuredImageIncludeBrandColors": true,
"featuredImageIncludeBrandLogo": true,
"internalLinkVolume": 123,
"keepTableOfContents": true,
"autoUpdateExistingArticles": true,
"articleUpdateFrequency": "<string>",
"articleUpdateMinAgeDays": 123,
"authors": [
{
"name": "<string>",
"avatar": "<string>",
"url": "<string>",
"isDefault": true,
"cmsUsers": {
"wordpress": {
"id": "<string>",
"name": "<string>"
},
"ghost": {
"id": "<string>",
"name": "<string>"
}
}
}
]
}
'import requests
url = "https://api.snowseo.com/v3/settings/article-automation"
payload = {
"teamId": "<string>",
"automation": True,
"postingFrequency": "<string>",
"preferredPostingTime": "<string>",
"timeZone": "<string>",
"preferredTopicIds": ["<string>"],
"preferredArticleTypes": ["<string>"],
"preferredCMSProvider": "<string>",
"writingLanguage": "<string>",
"useHumanizer": True,
"optionalSections": {
"faq": True,
"conclusion": True,
"cta": True,
"tldr": True,
"videos": True
},
"contentTone": ["<string>"],
"defaultImageProvider": "<string>",
"featuredImageStyles": ["<string>"],
"inArticleImageStyles": ["<string>"],
"customFeaturedImageReferenceUrl": "<string>",
"featuredImageText": True,
"featuredImageIncludeBrandColors": True,
"featuredImageIncludeBrandLogo": True,
"internalLinkVolume": 123,
"keepTableOfContents": True,
"autoUpdateExistingArticles": True,
"articleUpdateFrequency": "<string>",
"articleUpdateMinAgeDays": 123,
"authors": [
{
"name": "<string>",
"avatar": "<string>",
"url": "<string>",
"isDefault": True,
"cmsUsers": {
"wordpress": {
"id": "<string>",
"name": "<string>"
},
"ghost": {
"id": "<string>",
"name": "<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({
teamId: '<string>',
automation: true,
postingFrequency: '<string>',
preferredPostingTime: '<string>',
timeZone: '<string>',
preferredTopicIds: ['<string>'],
preferredArticleTypes: ['<string>'],
preferredCMSProvider: '<string>',
writingLanguage: '<string>',
useHumanizer: true,
optionalSections: {faq: true, conclusion: true, cta: true, tldr: true, videos: true},
contentTone: ['<string>'],
defaultImageProvider: '<string>',
featuredImageStyles: ['<string>'],
inArticleImageStyles: ['<string>'],
customFeaturedImageReferenceUrl: '<string>',
featuredImageText: true,
featuredImageIncludeBrandColors: true,
featuredImageIncludeBrandLogo: true,
internalLinkVolume: 123,
keepTableOfContents: true,
autoUpdateExistingArticles: true,
articleUpdateFrequency: '<string>',
articleUpdateMinAgeDays: 123,
authors: [
{
name: '<string>',
avatar: '<string>',
url: '<string>',
isDefault: true,
cmsUsers: {
wordpress: {id: '<string>', name: '<string>'},
ghost: {id: '<string>', name: '<string>'}
}
}
]
})
};
fetch('https://api.snowseo.com/v3/settings/article-automation', 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.snowseo.com/v3/settings/article-automation",
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([
'teamId' => '<string>',
'automation' => true,
'postingFrequency' => '<string>',
'preferredPostingTime' => '<string>',
'timeZone' => '<string>',
'preferredTopicIds' => [
'<string>'
],
'preferredArticleTypes' => [
'<string>'
],
'preferredCMSProvider' => '<string>',
'writingLanguage' => '<string>',
'useHumanizer' => true,
'optionalSections' => [
'faq' => true,
'conclusion' => true,
'cta' => true,
'tldr' => true,
'videos' => true
],
'contentTone' => [
'<string>'
],
'defaultImageProvider' => '<string>',
'featuredImageStyles' => [
'<string>'
],
'inArticleImageStyles' => [
'<string>'
],
'customFeaturedImageReferenceUrl' => '<string>',
'featuredImageText' => true,
'featuredImageIncludeBrandColors' => true,
'featuredImageIncludeBrandLogo' => true,
'internalLinkVolume' => 123,
'keepTableOfContents' => true,
'autoUpdateExistingArticles' => true,
'articleUpdateFrequency' => '<string>',
'articleUpdateMinAgeDays' => 123,
'authors' => [
[
'name' => '<string>',
'avatar' => '<string>',
'url' => '<string>',
'isDefault' => true,
'cmsUsers' => [
'wordpress' => [
'id' => '<string>',
'name' => '<string>'
],
'ghost' => [
'id' => '<string>',
'name' => '<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.snowseo.com/v3/settings/article-automation"
payload := strings.NewReader("{\n \"teamId\": \"<string>\",\n \"automation\": true,\n \"postingFrequency\": \"<string>\",\n \"preferredPostingTime\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"preferredTopicIds\": [\n \"<string>\"\n ],\n \"preferredArticleTypes\": [\n \"<string>\"\n ],\n \"preferredCMSProvider\": \"<string>\",\n \"writingLanguage\": \"<string>\",\n \"useHumanizer\": true,\n \"optionalSections\": {\n \"faq\": true,\n \"conclusion\": true,\n \"cta\": true,\n \"tldr\": true,\n \"videos\": true\n },\n \"contentTone\": [\n \"<string>\"\n ],\n \"defaultImageProvider\": \"<string>\",\n \"featuredImageStyles\": [\n \"<string>\"\n ],\n \"inArticleImageStyles\": [\n \"<string>\"\n ],\n \"customFeaturedImageReferenceUrl\": \"<string>\",\n \"featuredImageText\": true,\n \"featuredImageIncludeBrandColors\": true,\n \"featuredImageIncludeBrandLogo\": true,\n \"internalLinkVolume\": 123,\n \"keepTableOfContents\": true,\n \"autoUpdateExistingArticles\": true,\n \"articleUpdateFrequency\": \"<string>\",\n \"articleUpdateMinAgeDays\": 123,\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"url\": \"<string>\",\n \"isDefault\": true,\n \"cmsUsers\": {\n \"wordpress\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"ghost\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n }\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.snowseo.com/v3/settings/article-automation")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"teamId\": \"<string>\",\n \"automation\": true,\n \"postingFrequency\": \"<string>\",\n \"preferredPostingTime\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"preferredTopicIds\": [\n \"<string>\"\n ],\n \"preferredArticleTypes\": [\n \"<string>\"\n ],\n \"preferredCMSProvider\": \"<string>\",\n \"writingLanguage\": \"<string>\",\n \"useHumanizer\": true,\n \"optionalSections\": {\n \"faq\": true,\n \"conclusion\": true,\n \"cta\": true,\n \"tldr\": true,\n \"videos\": true\n },\n \"contentTone\": [\n \"<string>\"\n ],\n \"defaultImageProvider\": \"<string>\",\n \"featuredImageStyles\": [\n \"<string>\"\n ],\n \"inArticleImageStyles\": [\n \"<string>\"\n ],\n \"customFeaturedImageReferenceUrl\": \"<string>\",\n \"featuredImageText\": true,\n \"featuredImageIncludeBrandColors\": true,\n \"featuredImageIncludeBrandLogo\": true,\n \"internalLinkVolume\": 123,\n \"keepTableOfContents\": true,\n \"autoUpdateExistingArticles\": true,\n \"articleUpdateFrequency\": \"<string>\",\n \"articleUpdateMinAgeDays\": 123,\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"url\": \"<string>\",\n \"isDefault\": true,\n \"cmsUsers\": {\n \"wordpress\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"ghost\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.snowseo.com/v3/settings/article-automation")
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 \"teamId\": \"<string>\",\n \"automation\": true,\n \"postingFrequency\": \"<string>\",\n \"preferredPostingTime\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"preferredTopicIds\": [\n \"<string>\"\n ],\n \"preferredArticleTypes\": [\n \"<string>\"\n ],\n \"preferredCMSProvider\": \"<string>\",\n \"writingLanguage\": \"<string>\",\n \"useHumanizer\": true,\n \"optionalSections\": {\n \"faq\": true,\n \"conclusion\": true,\n \"cta\": true,\n \"tldr\": true,\n \"videos\": true\n },\n \"contentTone\": [\n \"<string>\"\n ],\n \"defaultImageProvider\": \"<string>\",\n \"featuredImageStyles\": [\n \"<string>\"\n ],\n \"inArticleImageStyles\": [\n \"<string>\"\n ],\n \"customFeaturedImageReferenceUrl\": \"<string>\",\n \"featuredImageText\": true,\n \"featuredImageIncludeBrandColors\": true,\n \"featuredImageIncludeBrandLogo\": true,\n \"internalLinkVolume\": 123,\n \"keepTableOfContents\": true,\n \"autoUpdateExistingArticles\": true,\n \"articleUpdateFrequency\": \"<string>\",\n \"articleUpdateMinAgeDays\": 123,\n \"authors\": [\n {\n \"name\": \"<string>\",\n \"avatar\": \"<string>\",\n \"url\": \"<string>\",\n \"isDefault\": true,\n \"cmsUsers\": {\n \"wordpress\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n },\n \"ghost\": {\n \"id\": \"<string>\",\n \"name\": \"<string>\"\n }\n }\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "<string>"
}preferredCMSProvider must be one of the brand’s connected integrations (or embed, which is always available), or the request returns 400. preferredPostingTime must be a valid window name or HH:MM, otherwise 400. timeZone is written to the brand’s timezone, not just to the automation settings. preferredTopicIds, preferredArticleTypes, and the image-style arrays are filtered to known/owned values, so unsupported entries are silently dropped. An unrecognized postingFrequency is silently coerced to every-7-days rather than rejected; changing the cadence re-spaces pending content-planner rows. An unrecognized writingLanguage code is ignored; send an explicit null to clear it back to the brand’s default language. authors replaces the whole list: names are trimmed and de-duplicated, at most 20 are kept, and an avatar or url that is not an http(s) link is dropped.writingLanguage only affects articles created after the change. Each article records the language it was written in, so existing articles keep theirs when they are refreshed, audited, or edited.Authorizations
Your SnowSEO API key (sk_...).
Body
draft, published short, medium, long Language code articles are written in (e.g. 'es'). Usually two letters; Chinese is 'zh_CN'/'zh_TW' and Hebrew is 'iw'. Null clears it back to inheriting the brand language. Applies to articles only - keyword research, SERP data and AI-visibility tracking stay on the brand language.
Optional sections generated into each article.
Show child attributes
Show child attributes
Writing-tone pool; one tone is picked per article. Empty means any tone. Values: Professional (Formal, business-focused), Conversational (Friendly, approachable), Expert (Authoritative, technical), Casual (Friendly, conversational), Academic (Research-based, scholarly), Creative (Storytelling, engaging).
Where article images come from: 'ai' (generated), 'stock' (stock photos), or null for no images.
Style pool for AI featured images; one is picked per article. Used when defaultImageProvider is 'ai'. Values: airy, photographic, cartoonish, pencil-sketch, 3d-clay, custom.
Style pool for AI images inside the article body. Used when defaultImageProvider is 'ai'. Values: photographic, cartoonish, pencil-sketch, infographic.
Reference image for the 'custom' featured image style. Null clears it.
Include text in AI featured images.
Use the brand colours in AI featured images.
Put the brand logo into AI featured images.
Keep the generated table of contents when publishing. Default false - most CMS themes render their own, so ours goes out as a duplicate.
The brand's reusable authors. Those with isDefault go on every new article; the first is the primary byline.
Show child attributes
Show child attributes
Was this page helpful?

