curl --request PATCH \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/theme \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "<string>",
"cardName": "<string>",
"color": "#1ec968",
"icon": "fas fa-wrench",
"description": "<string>",
"shortCode": "<string>"
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/theme"
payload = {
"name": "<string>",
"cardName": "<string>",
"color": "#1ec968",
"icon": "fas fa-wrench",
"description": "<string>",
"shortCode": "<string>"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cardName: '<string>',
color: '#1ec968',
icon: 'fas fa-wrench',
description: '<string>',
shortCode: '<string>'
})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/theme', 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://core-api.getaptly.com/api/board/{boardId}/configuration/theme",
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>',
'cardName' => '<string>',
'color' => '#1ec968',
'icon' => 'fas fa-wrench',
'description' => '<string>',
'shortCode' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <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://core-api.getaptly.com/api/board/{boardId}/configuration/theme"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cardName\": \"<string>\",\n \"color\": \"#1ec968\",\n \"icon\": \"fas fa-wrench\",\n \"description\": \"<string>\",\n \"shortCode\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-token", "<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://core-api.getaptly.com/api/board/{boardId}/configuration/theme")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cardName\": \"<string>\",\n \"color\": \"#1ec968\",\n \"icon\": \"fas fa-wrench\",\n \"description\": \"<string>\",\n \"shortCode\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/theme")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cardName\": \"<string>\",\n \"color\": \"#1ec968\",\n \"icon\": \"fas fa-wrench\",\n \"description\": \"<string>\",\n \"shortCode\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "<string>",
"cardName": "<string>",
"color": "<string>",
"icon": "<string>",
"description": "<string>",
"shortCode": "<string>"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "One or more fields are invalid",
"meta": {
"issues": [
{
"field": "to.0.value",
"code": "invalid_format",
"message": "must be a valid email address"
}
]
}
},
"requestId": "<string>"
}Update board identity fields
Updates any of the board’s name, cardName, color, icon, description and shortCode;
at least one is required. color must be a hex color, icon a Font Awesome class string, and
shortCode 1-5 letters or numbers (stored uppercase). Requires update permission and the
key’s “Edit Boards” access (not needed on a board that same key created).
curl --request PATCH \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/theme \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "<string>",
"cardName": "<string>",
"color": "#1ec968",
"icon": "fas fa-wrench",
"description": "<string>",
"shortCode": "<string>"
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/theme"
payload = {
"name": "<string>",
"cardName": "<string>",
"color": "#1ec968",
"icon": "fas fa-wrench",
"description": "<string>",
"shortCode": "<string>"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cardName: '<string>',
color: '#1ec968',
icon: 'fas fa-wrench',
description: '<string>',
shortCode: '<string>'
})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/theme', 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://core-api.getaptly.com/api/board/{boardId}/configuration/theme",
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>',
'cardName' => '<string>',
'color' => '#1ec968',
'icon' => 'fas fa-wrench',
'description' => '<string>',
'shortCode' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-token: <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://core-api.getaptly.com/api/board/{boardId}/configuration/theme"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cardName\": \"<string>\",\n \"color\": \"#1ec968\",\n \"icon\": \"fas fa-wrench\",\n \"description\": \"<string>\",\n \"shortCode\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-token", "<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://core-api.getaptly.com/api/board/{boardId}/configuration/theme")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cardName\": \"<string>\",\n \"color\": \"#1ec968\",\n \"icon\": \"fas fa-wrench\",\n \"description\": \"<string>\",\n \"shortCode\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/theme")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cardName\": \"<string>\",\n \"color\": \"#1ec968\",\n \"icon\": \"fas fa-wrench\",\n \"description\": \"<string>\",\n \"shortCode\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"name": "<string>",
"cardName": "<string>",
"color": "<string>",
"icon": "<string>",
"description": "<string>",
"shortCode": "<string>"
}
}{
"error": {
"code": "VALIDATION_ERROR",
"message": "One or more fields are invalid",
"meta": {
"issues": [
{
"field": "to.0.value",
"code": "invalid_format",
"message": "must be a valid email address"
}
]
}
},
"requestId": "<string>"
}Headers
Required with a partner bearer token (board-admin): the company that owns the board.
Standard boards such as unit share one board UUID across companies, so the board is
looked up by UUID within this company. companyId in the request body or query string
is also accepted. A partner request without a company is rejected with MISSING_DATA
(400), and a board the company does not own is BOARD_NOT_FOUND (404). Ignored for API
keys, whose company comes from the key.