curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid} \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "<string>",
"optional": true,
"pinned": true,
"startCard": true,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>",
"color": "#1ec968",
"closed": true,
"won": true
}
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
payload = {
"name": "<string>",
"optional": True,
"pinned": True,
"startCard": True,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>",
"color": "#1ec968",
"closed": True,
"won": True
}
]
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
optional: true,
pinned: true,
startCard: true,
defaultValue: '<string>',
data: [
{label: '<string>', uuid: '<string>', color: '#1ec968', closed: true, won: true}
]
})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}', 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/fields/{fieldUuid}",
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([
'name' => '<string>',
'optional' => true,
'pinned' => true,
'startCard' => true,
'defaultValue' => '<string>',
'data' => [
[
'label' => '<string>',
'uuid' => '<string>',
'color' => '#1ec968',
'closed' => true,
'won' => true
]
]
]),
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/fields/{fieldUuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"startCard\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\",\n \"color\": \"#1ec968\",\n \"closed\": true,\n \"won\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"startCard\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\",\n \"color\": \"#1ec968\",\n \"closed\": true,\n \"won\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"startCard\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\",\n \"color\": \"#1ec968\",\n \"closed\": true,\n \"won\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"name": "<string>",
"type": "<string>",
"position": 123,
"optional": true,
"startCard": true,
"archived": true
}
}{
"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 a field
Updates a field’s name, optional, pinned, startCard, defaultValue and - for select-type fields -
its full data option list. A field’s type and uuid never change. Options re-sent by label
keep their uuid. Refused (403) for locked fields - except startCard, which any field accepts - and the options of integration-managed
fields. Requires update permission and “Edit Boards” access (not needed on a board that
same key created).
Renaming a field also rewrites its Board["Field"] merge tokens in the company’s templates
(best-effort: a failure there never fails the update).
Editing the stage pipeline (fieldUuid = stage): send the full data list in the order
you want. You can add stages, reorder them and recolor them. Existing stages are matched by
uuid (or by label when you leave uuid out) and keep their uuid. A stage that isn’t
matched is added: it gets a new uuid and may set color, closed and won (won is for
deal boards only and implies closed). Cards, automations and saved filters refer to stages
by name, so these are refused with 403: leaving an existing stage out (removing it), changing
an existing stage’s label (renaming it) and changing an existing stage between open,
closed and won. The first stage is where new cards start, so whichever stage ends up first
must be open (unless it was already first). Labels must be unique and there can be at most 30
stages. Board views that are open in the Aptly app refresh to show the change.
curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid} \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "<string>",
"optional": true,
"pinned": true,
"startCard": true,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>",
"color": "#1ec968",
"closed": true,
"won": true
}
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
payload = {
"name": "<string>",
"optional": True,
"pinned": True,
"startCard": True,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>",
"color": "#1ec968",
"closed": True,
"won": True
}
]
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
optional: true,
pinned: true,
startCard: true,
defaultValue: '<string>',
data: [
{label: '<string>', uuid: '<string>', color: '#1ec968', closed: true, won: true}
]
})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}', 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/fields/{fieldUuid}",
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([
'name' => '<string>',
'optional' => true,
'pinned' => true,
'startCard' => true,
'defaultValue' => '<string>',
'data' => [
[
'label' => '<string>',
'uuid' => '<string>',
'color' => '#1ec968',
'closed' => true,
'won' => true
]
]
]),
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/fields/{fieldUuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"startCard\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\",\n \"color\": \"#1ec968\",\n \"closed\": true,\n \"won\": true\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"startCard\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\",\n \"color\": \"#1ec968\",\n \"closed\": true,\n \"won\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"startCard\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\",\n \"color\": \"#1ec968\",\n \"closed\": true,\n \"won\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"name": "<string>",
"type": "<string>",
"position": 123,
"optional": true,
"startCard": true,
"archived": true
}
}{
"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.