Update CMS Item
curl --request PATCH \
--url https://api.kardow.com/cms/{slug}/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"data": {},
"expires_at": "2023-11-07T05:31:56Z",
"starts_at": "2023-11-07T05:31:56Z",
"position": 123
}
'import requests
url = "https://api.kardow.com/cms/{slug}/{id}"
payload = {
"data": {},
"expires_at": "2023-11-07T05:31:56Z",
"starts_at": "2023-11-07T05:31:56Z",
"position": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {},
expires_at: '2023-11-07T05:31:56Z',
starts_at: '2023-11-07T05:31:56Z',
position: 123
})
};
fetch('https://api.kardow.com/cms/{slug}/{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_URL => "https://api.kardow.com/cms/{slug}/{id}",
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([
'data' => [
],
'expires_at' => '2023-11-07T05:31:56Z',
'starts_at' => '2023-11-07T05:31:56Z',
'position' => 123
]),
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.kardow.com/cms/{slug}/{id}"
payload := strings.NewReader("{\n \"data\": {},\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"position\": 123\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.kardow.com/cms/{slug}/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {},\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"position\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kardow.com/cms/{slug}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {},\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"position\": 123\n}"
response = http.request(request)
puts response.read_body{
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {},
"status": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"position": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>",
"url": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>",
"url": "<string>"
}
}CMS
Update CMS Item
Partial update of an item. Only the fields you send are changed.
PATCH
/
cms
/
{slug}
/
{id}
Update CMS Item
curl --request PATCH \
--url https://api.kardow.com/cms/{slug}/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"data": {},
"expires_at": "2023-11-07T05:31:56Z",
"starts_at": "2023-11-07T05:31:56Z",
"position": 123
}
'import requests
url = "https://api.kardow.com/cms/{slug}/{id}"
payload = {
"data": {},
"expires_at": "2023-11-07T05:31:56Z",
"starts_at": "2023-11-07T05:31:56Z",
"position": 123
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
data: {},
expires_at: '2023-11-07T05:31:56Z',
starts_at: '2023-11-07T05:31:56Z',
position: 123
})
};
fetch('https://api.kardow.com/cms/{slug}/{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_URL => "https://api.kardow.com/cms/{slug}/{id}",
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([
'data' => [
],
'expires_at' => '2023-11-07T05:31:56Z',
'starts_at' => '2023-11-07T05:31:56Z',
'position' => 123
]),
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.kardow.com/cms/{slug}/{id}"
payload := strings.NewReader("{\n \"data\": {},\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"position\": 123\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.kardow.com/cms/{slug}/{id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"data\": {},\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"position\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.kardow.com/cms/{slug}/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": {},\n \"expires_at\": \"2023-11-07T05:31:56Z\",\n \"starts_at\": \"2023-11-07T05:31:56Z\",\n \"position\": 123\n}"
response = http.request(request)
puts response.read_body{
"item": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"data": {},
"status": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"expires_at": "2023-11-07T05:31:56Z",
"position": 123,
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>",
"url": "<string>"
}
}{
"error": {
"message": "<string>",
"code": "<string>",
"details": "<unknown>",
"url": "<string>"
}
}When you send
data, the entire data payload is replaced (and validated).
Send only status, expires_at, starts_at, or position to change those
without touching the data shape.Authorizations
API key for authentication. Get yours from Settings > API Keys in the Kardow dashboard.
Body
application/json
Response
Updated
Show child attributes
Show child attributes
Was this page helpful?
āI