curl --request PUT \
--url http://localhost:3001/portal-api/posts/{post_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Title": "<string>",
"Lede": "<string>",
"Content": "<string>",
"Status": "<string>",
"Path": "<string>",
"Categories": [
"<string>"
],
"Tags": [
"<string>"
],
"MarkdownEnabled": true,
"MarkdownContent": "<string>",
"PreviewContent": "<string>"
}
'import requests
url = "http://localhost:3001/portal-api/posts/{post_id}"
payload = {
"Title": "<string>",
"Lede": "<string>",
"Content": "<string>",
"Status": "<string>",
"Path": "<string>",
"Categories": ["<string>"],
"Tags": ["<string>"],
"MarkdownEnabled": True,
"MarkdownContent": "<string>",
"PreviewContent": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Title: '<string>',
Lede: '<string>',
Content: '<string>',
Status: '<string>',
Path: '<string>',
Categories: ['<string>'],
Tags: ['<string>'],
MarkdownEnabled: true,
MarkdownContent: '<string>',
PreviewContent: '<string>'
})
};
fetch('http://localhost:3001/portal-api/posts/{post_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/posts/{post_id}",
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([
'Title' => '<string>',
'Lede' => '<string>',
'Content' => '<string>',
'Status' => '<string>',
'Path' => '<string>',
'Categories' => [
'<string>'
],
'Tags' => [
'<string>'
],
'MarkdownEnabled' => true,
'MarkdownContent' => '<string>',
'PreviewContent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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 := "http://localhost:3001/portal-api/posts/{post_id}"
payload := strings.NewReader("{\n \"Title\": \"<string>\",\n \"Lede\": \"<string>\",\n \"Content\": \"<string>\",\n \"Status\": \"<string>\",\n \"Path\": \"<string>\",\n \"Categories\": [\n \"<string>\"\n ],\n \"Tags\": [\n \"<string>\"\n ],\n \"MarkdownEnabled\": true,\n \"MarkdownContent\": \"<string>\",\n \"PreviewContent\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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("http://localhost:3001/portal-api/posts/{post_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Title\": \"<string>\",\n \"Lede\": \"<string>\",\n \"Content\": \"<string>\",\n \"Status\": \"<string>\",\n \"Path\": \"<string>\",\n \"Categories\": [\n \"<string>\"\n ],\n \"Tags\": [\n \"<string>\"\n ],\n \"MarkdownEnabled\": true,\n \"MarkdownContent\": \"<string>\",\n \"PreviewContent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/posts/{post_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Title\": \"<string>\",\n \"Lede\": \"<string>\",\n \"Content\": \"<string>\",\n \"Status\": \"<string>\",\n \"Path\": \"<string>\",\n \"Categories\": [\n \"<string>\"\n ],\n \"Tags\": [\n \"<string>\"\n ],\n \"MarkdownEnabled\": true,\n \"MarkdownContent\": \"<string>\",\n \"PreviewContent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ID": "<string>",
"Title": "<string>",
"Lede": "<string>",
"Content": "<string>",
"Status": "<string>",
"Path": "<string>",
"Categories": [
{
"ID": "<string>",
"Name": "<string>",
"CreatedAt": "2023-06-25 13:37",
"UpdatedAt": "2023-06-25 13:37"
}
],
"Tags": [
{
"ID": "<string>",
"Name": "<string>",
"CreatedAt": "2023-06-25 13:37",
"UpdatedAt": "2023-06-25 13:37"
}
],
"MarkdownEnabled": true,
"MarkdownContent": "<string>",
"PreviewContent": "<string>",
"CreatedAt": "2023-06-25 13:37",
"UpdatedAt": "2023-06-25 13:37"
}Update a post
Update a post’s data such as title, content, status, and more.
curl --request PUT \
--url http://localhost:3001/portal-api/posts/{post_id} \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"Title": "<string>",
"Lede": "<string>",
"Content": "<string>",
"Status": "<string>",
"Path": "<string>",
"Categories": [
"<string>"
],
"Tags": [
"<string>"
],
"MarkdownEnabled": true,
"MarkdownContent": "<string>",
"PreviewContent": "<string>"
}
'import requests
url = "http://localhost:3001/portal-api/posts/{post_id}"
payload = {
"Title": "<string>",
"Lede": "<string>",
"Content": "<string>",
"Status": "<string>",
"Path": "<string>",
"Categories": ["<string>"],
"Tags": ["<string>"],
"MarkdownEnabled": True,
"MarkdownContent": "<string>",
"PreviewContent": "<string>"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
Title: '<string>',
Lede: '<string>',
Content: '<string>',
Status: '<string>',
Path: '<string>',
Categories: ['<string>'],
Tags: ['<string>'],
MarkdownEnabled: true,
MarkdownContent: '<string>',
PreviewContent: '<string>'
})
};
fetch('http://localhost:3001/portal-api/posts/{post_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/portal-api/posts/{post_id}",
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([
'Title' => '<string>',
'Lede' => '<string>',
'Content' => '<string>',
'Status' => '<string>',
'Path' => '<string>',
'Categories' => [
'<string>'
],
'Tags' => [
'<string>'
],
'MarkdownEnabled' => true,
'MarkdownContent' => '<string>',
'PreviewContent' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <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 := "http://localhost:3001/portal-api/posts/{post_id}"
payload := strings.NewReader("{\n \"Title\": \"<string>\",\n \"Lede\": \"<string>\",\n \"Content\": \"<string>\",\n \"Status\": \"<string>\",\n \"Path\": \"<string>\",\n \"Categories\": [\n \"<string>\"\n ],\n \"Tags\": [\n \"<string>\"\n ],\n \"MarkdownEnabled\": true,\n \"MarkdownContent\": \"<string>\",\n \"PreviewContent\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "<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("http://localhost:3001/portal-api/posts/{post_id}")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"Title\": \"<string>\",\n \"Lede\": \"<string>\",\n \"Content\": \"<string>\",\n \"Status\": \"<string>\",\n \"Path\": \"<string>\",\n \"Categories\": [\n \"<string>\"\n ],\n \"Tags\": [\n \"<string>\"\n ],\n \"MarkdownEnabled\": true,\n \"MarkdownContent\": \"<string>\",\n \"PreviewContent\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/portal-api/posts/{post_id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"Title\": \"<string>\",\n \"Lede\": \"<string>\",\n \"Content\": \"<string>\",\n \"Status\": \"<string>\",\n \"Path\": \"<string>\",\n \"Categories\": [\n \"<string>\"\n ],\n \"Tags\": [\n \"<string>\"\n ],\n \"MarkdownEnabled\": true,\n \"MarkdownContent\": \"<string>\",\n \"PreviewContent\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"ID": "<string>",
"Title": "<string>",
"Lede": "<string>",
"Content": "<string>",
"Status": "<string>",
"Path": "<string>",
"Categories": [
{
"ID": "<string>",
"Name": "<string>",
"CreatedAt": "2023-06-25 13:37",
"UpdatedAt": "2023-06-25 13:37"
}
],
"Tags": [
{
"ID": "<string>",
"Name": "<string>",
"CreatedAt": "2023-06-25 13:37",
"UpdatedAt": "2023-06-25 13:37"
}
],
"MarkdownEnabled": true,
"MarkdownContent": "<string>",
"PreviewContent": "<string>",
"CreatedAt": "2023-06-25 13:37",
"UpdatedAt": "2023-06-25 13:37"
}Authorizations
Path Parameters
UID of a post
1
Body
Title of the post
Short summary or lead paragraph of the post
Full content of the post
Status of the post (e.g., draft, published)
URL path for the post
List of category IDs to associate with the post
List of tag IDs to associate with the post
Whether Markdown is enabled for this post
Content of the post in Markdown format, if Markdown is enabled
Preview content of the post
Response
OK
Unique identifier for the post
Title of the post
Short summary or lead paragraph of the post
Full content of the post
Status of the post (e.g., draft, published)
URL path for the post
List of categories associated with the post
Show child attributes
Show child attributes
List of tags associated with the post
Show child attributes
Show child attributes
Whether Markdown is enabled for this post
Content of the post in Markdown format, if Markdown is enabled
Preview content of the post
Timestamp of when this post was created
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$"2023-06-25 13:37"
Timestamp of when this post was last updated
^\d{4}-\d{2}-\d{2} \d{2}:\d{2}$"2023-06-25 13:37"
Was this page helpful?