Articles
Update Article
Update Article.
PUT
/
articles
/
update
Update article
curl --request PUT \
--url https://api.octaviatech.app/cms/articles/update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"id": "{{objectId}}",
"mainTitle": {
"en": "Hello World (updated)",
"es": "Hola Mundo (actualizado)"
},
"tags": [
"news",
"ai",
"ml"
]
}
'import requests
url = "https://api.octaviatech.app/cms/articles/update"
payload = {
"id": "{{objectId}}",
"mainTitle": {
"en": "Hello World (updated)",
"es": "Hola Mundo (actualizado)"
},
"tags": ["news", "ai", "ml"]
}
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}}',
mainTitle: {en: 'Hello World (updated)', es: 'Hola Mundo (actualizado)'},
tags: ['news', 'ai', 'ml']
})
};
fetch('https://api.octaviatech.app/cms/articles/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/articles/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}}',
'mainTitle' => [
'en' => 'Hello World (updated)',
'es' => 'Hola Mundo (actualizado)'
],
'tags' => [
'news',
'ai',
'ml'
]
]),
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/articles/update"
payload := strings.NewReader("{\n \"id\": \"{{objectId}}\",\n \"mainTitle\": {\n \"en\": \"Hello World (updated)\",\n \"es\": \"Hola Mundo (actualizado)\"\n },\n \"tags\": [\n \"news\",\n \"ai\",\n \"ml\"\n ]\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/articles/update")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"{{objectId}}\",\n \"mainTitle\": {\n \"en\": \"Hello World (updated)\",\n \"es\": \"Hola Mundo (actualizado)\"\n },\n \"tags\": [\n \"news\",\n \"ai\",\n \"ml\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/articles/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 \"mainTitle\": {\n \"en\": \"Hello World (updated)\",\n \"es\": \"Hola Mundo (actualizado)\"\n },\n \"tags\": [\n \"news\",\n \"ai\",\n \"ml\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 201,
"message": "Article updated",
"data": {
"id": "{{objectId}}"
}
}{
"success": false,
"statusCode": 401,
"message": "Unauthorized",
"data": null
}{
"success": false,
"statusCode": 403,
"message": "Forbidden",
"data": null
}{
"success": false,
"statusCode": 404,
"message": "Not found",
"data": null
}{
"success": false,
"statusCode": 422,
"message": "Validation failed",
"data": null
}{
"success": false,
"statusCode": 500,
"message": "Internal server error",
"data": null
}When updating an article, only the fields you include in the request will be updated — all other fields remain unchanged.
The only required field is
id, which identifies the article to update.Authorizations
Body
application/json
Pattern:
^[a-fA-F0-9]{24}$Example:
"{{objectId}}"
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^[a-fA-F0-9]{24}$Pattern:
^[a-fA-F0-9]{24}$Pattern:
^[a-fA-F0-9]{24}$Response
Updated
Was this page helpful?
⌘I
Update article
curl --request PUT \
--url https://api.octaviatech.app/cms/articles/update \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"id": "{{objectId}}",
"mainTitle": {
"en": "Hello World (updated)",
"es": "Hola Mundo (actualizado)"
},
"tags": [
"news",
"ai",
"ml"
]
}
'import requests
url = "https://api.octaviatech.app/cms/articles/update"
payload = {
"id": "{{objectId}}",
"mainTitle": {
"en": "Hello World (updated)",
"es": "Hola Mundo (actualizado)"
},
"tags": ["news", "ai", "ml"]
}
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}}',
mainTitle: {en: 'Hello World (updated)', es: 'Hola Mundo (actualizado)'},
tags: ['news', 'ai', 'ml']
})
};
fetch('https://api.octaviatech.app/cms/articles/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/articles/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}}',
'mainTitle' => [
'en' => 'Hello World (updated)',
'es' => 'Hola Mundo (actualizado)'
],
'tags' => [
'news',
'ai',
'ml'
]
]),
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/articles/update"
payload := strings.NewReader("{\n \"id\": \"{{objectId}}\",\n \"mainTitle\": {\n \"en\": \"Hello World (updated)\",\n \"es\": \"Hola Mundo (actualizado)\"\n },\n \"tags\": [\n \"news\",\n \"ai\",\n \"ml\"\n ]\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/articles/update")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"id\": \"{{objectId}}\",\n \"mainTitle\": {\n \"en\": \"Hello World (updated)\",\n \"es\": \"Hola Mundo (actualizado)\"\n },\n \"tags\": [\n \"news\",\n \"ai\",\n \"ml\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.octaviatech.app/cms/articles/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 \"mainTitle\": {\n \"en\": \"Hello World (updated)\",\n \"es\": \"Hola Mundo (actualizado)\"\n },\n \"tags\": [\n \"news\",\n \"ai\",\n \"ml\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"statusCode": 201,
"message": "Article updated",
"data": {
"id": "{{objectId}}"
}
}{
"success": false,
"statusCode": 401,
"message": "Unauthorized",
"data": null
}{
"success": false,
"statusCode": 403,
"message": "Forbidden",
"data": null
}{
"success": false,
"statusCode": 404,
"message": "Not found",
"data": null
}{
"success": false,
"statusCode": 422,
"message": "Validation failed",
"data": null
}{
"success": false,
"statusCode": 500,
"message": "Internal server error",
"data": null
}
