Update a field
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,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>"
}
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
payload = {
"name": "<string>",
"optional": True,
"pinned": True,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>"
}
]
}
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,
defaultValue: '<string>',
data: [{label: '<string>', uuid: '<string>'}]
})
};
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,
'defaultValue' => '<string>',
'data' => [
[
'label' => '<string>',
'uuid' => '<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/fields/{fieldUuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\"\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 \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\"\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 \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"name": "<string>",
"type": "<string>",
"position": 123,
"optional": 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>"
}Board
Update a field
Updates a field’s name, optional, pinned, 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, the stage pipeline’s options, and the
options of integration-managed fields. Requires update permission and “Edit Boards” access.
PUT
/
api
/
board
/
{boardId}
/
configuration
/
fields
/
{fieldUuid}
Update a field
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,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>"
}
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
payload = {
"name": "<string>",
"optional": True,
"pinned": True,
"defaultValue": "<string>",
"data": [
{
"label": "<string>",
"uuid": "<string>"
}
]
}
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,
defaultValue: '<string>',
data: [{label: '<string>', uuid: '<string>'}]
})
};
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,
'defaultValue' => '<string>',
'data' => [
[
'label' => '<string>',
'uuid' => '<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/fields/{fieldUuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"optional\": true,\n \"pinned\": true,\n \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\"\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 \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\"\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 \"defaultValue\": \"<string>\",\n \"data\": [\n {\n \"label\": \"<string>\",\n \"uuid\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"name": "<string>",
"type": "<string>",
"position": 123,
"optional": 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>"
}Authorizations
ApiKeyHeaderPartnerBearer
Body
application/json
Response
The updated field.
Show child attributes
Show child attributes