Update Project
curl --request PATCH \
--url https://api.example.com/api/v1/projects/{public_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_starred": true,
"is_template": true,
"color": "<string>",
"thumb_asset_id": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/projects/{public_id}"
payload = {
"name": "<string>",
"is_starred": True,
"is_template": True,
"color": "<string>",
"thumb_asset_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_starred: true,
is_template: true,
color: '<string>',
thumb_asset_id: '<string>'
})
};
fetch('https://api.example.com/api/v1/projects/{public_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.example.com/api/v1/projects/{public_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([
'name' => '<string>',
'is_starred' => true,
'is_template' => true,
'color' => '<string>',
'thumb_asset_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/projects/{public_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_starred\": true,\n \"is_template\": true,\n \"color\": \"<string>\",\n \"thumb_asset_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/api/v1/projects/{public_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_starred\": true,\n \"is_template\": true,\n \"color\": \"<string>\",\n \"thumb_asset_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/projects/{public_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_starred\": true,\n \"is_template\": true,\n \"color\": \"<string>\",\n \"thumb_asset_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}projects
Update Project
Rename / star / template / color / set the cover thumb (all optional; 404 if absent or trashed).
PATCH
/
api
/
v1
/
projects
/
{public_id}
Update Project
curl --request PATCH \
--url https://api.example.com/api/v1/projects/{public_id} \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"is_starred": true,
"is_template": true,
"color": "<string>",
"thumb_asset_id": "<string>"
}
'import requests
url = "https://api.example.com/api/v1/projects/{public_id}"
payload = {
"name": "<string>",
"is_starred": True,
"is_template": True,
"color": "<string>",
"thumb_asset_id": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
is_starred: true,
is_template: true,
color: '<string>',
thumb_asset_id: '<string>'
})
};
fetch('https://api.example.com/api/v1/projects/{public_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.example.com/api/v1/projects/{public_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([
'name' => '<string>',
'is_starred' => true,
'is_template' => true,
'color' => '<string>',
'thumb_asset_id' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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.example.com/api/v1/projects/{public_id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"is_starred\": true,\n \"is_template\": true,\n \"color\": \"<string>\",\n \"thumb_asset_id\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.example.com/api/v1/projects/{public_id}")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"is_starred\": true,\n \"is_template\": true,\n \"color\": \"<string>\",\n \"thumb_asset_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/v1/projects/{public_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"is_starred\": true,\n \"is_template\": true,\n \"color\": \"<string>\",\n \"thumb_asset_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Path Parameters
Body
application/json
Partial update (#172) — only fields actually sent are applied (model_fields_set, the
files-router idiom), so color: null explicitly clears while an omitted field is left alone.
Response
Successful Response
The response is of type Response Update Project Api V1 Projects Public Id Patch · object.
⌘I