Update author
curl --request PUT \
--url https://api.octaviatech.app/cms/authors/update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"id": "{{objectId}}",
"name": {
"en": "John Carter (updated)",
"es": "Juan Carter (actualizado)"
},
"isActive": true
}
'import requests
url = "https://api.octaviatech.app/cms/authors/update"
payload = {
"id": "{{objectId}}",
"name": {
"en": "John Carter (updated)",
"es": "Juan Carter (actualizado)"
},
"isActive": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '{{objectId}}',
name: {en: 'John Carter (updated)', es: 'Juan Carter (actualizado)'},
isActive: true
})
};
fetch('https://api.octaviatech.app/cms/authors/update', 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.octaviatech.app/cms/authors/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '{{objectId}}',
'name' => [
'en' => 'John Carter (updated)',
'es' => 'Juan Carter (actualizado)'
],
'isActive' => true
]),
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.octaviatech.app/cms/authors/update"
payload := strings.NewReader("{\n \"id\": \"{{objectId}}\",\n \"name\": {\n \"en\": \"John Carter (updated)\",\n \"es\": \"Juan Carter (actualizado)\"\n },\n \"isActive\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.octaviatech.app/cms/authors/update")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"{{objectId}}\",\n \"name\": {\n \"en\": \"John Carter (updated)\",\n \"es\": \"Juan Carter (actualizado)\"\n },\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/authors/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"{{objectId}}\",\n \"name\": {\n \"en\": \"John Carter (updated)\",\n \"es\": \"Juan Carter (actualizado)\"\n },\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Author updated successfully",
"data": {
"author": {
"id": "{{objectId}}"
}
}
}{
"success": false,
"statusCode": 401,
"message": "Unauthorized",
"data": null
}{
"success": false,
"statusCode": 403,
"message": "Forbidden",
"data": null
}{
"success": false,
"statusCode": 404,
"message": "Author not found",
"data": null
}{
"success": false,
"statusCode": 409,
"message": "Validation Error",
"data": null
}{
"success": false,
"statusCode": 500,
"message": "Server Error",
"data": null
}Authors
Update author
Partial update. Provide only fields to change, plus id.
PUT
/
authors
/
update
Update author
curl --request PUT \
--url https://api.octaviatech.app/cms/authors/update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"id": "{{objectId}}",
"name": {
"en": "John Carter (updated)",
"es": "Juan Carter (actualizado)"
},
"isActive": true
}
'import requests
url = "https://api.octaviatech.app/cms/authors/update"
payload = {
"id": "{{objectId}}",
"name": {
"en": "John Carter (updated)",
"es": "Juan Carter (actualizado)"
},
"isActive": True
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
id: '{{objectId}}',
name: {en: 'John Carter (updated)', es: 'Juan Carter (actualizado)'},
isActive: true
})
};
fetch('https://api.octaviatech.app/cms/authors/update', 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.octaviatech.app/cms/authors/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'id' => '{{objectId}}',
'name' => [
'en' => 'John Carter (updated)',
'es' => 'Juan Carter (actualizado)'
],
'isActive' => true
]),
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.octaviatech.app/cms/authors/update"
payload := strings.NewReader("{\n \"id\": \"{{objectId}}\",\n \"name\": {\n \"en\": \"John Carter (updated)\",\n \"es\": \"Juan Carter (actualizado)\"\n },\n \"isActive\": true\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.octaviatech.app/cms/authors/update")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"{{objectId}}\",\n \"name\": {\n \"en\": \"John Carter (updated)\",\n \"es\": \"Juan Carter (actualizado)\"\n },\n \"isActive\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/authors/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"id\": \"{{objectId}}\",\n \"name\": {\n \"en\": \"John Carter (updated)\",\n \"es\": \"Juan Carter (actualizado)\"\n },\n \"isActive\": true\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 200,
"message": "Author updated successfully",
"data": {
"author": {
"id": "{{objectId}}"
}
}
}{
"success": false,
"statusCode": 401,
"message": "Unauthorized",
"data": null
}{
"success": false,
"statusCode": 403,
"message": "Forbidden",
"data": null
}{
"success": false,
"statusCode": 404,
"message": "Author not found",
"data": null
}{
"success": false,
"statusCode": 409,
"message": "Validation Error",
"data": null
}{
"success": false,
"statusCode": 500,
"message": "Server Error",
"data": null
}Authorizations
Body
application/json
Pattern:
^[a-fA-F0-9]{24}$Example:
"{{objectId}}"
Author name keyed by language code. Keys must be language codes configured for the service.
Show child attributes
Show child attributes
URL-friendly unique identifier (unique per tenant).
Author bio keyed by language code (HTML allowed).
Show child attributes
Show child attributes
Avatar image URL.
Public contact email (unique per tenant).
Whether the author is hidden from public listings.
Whether author is active.
Response
Updated
Was this page helpful?

