Reorder fields
curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"fields": [
"dueAt",
"name",
"priority"
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order"
payload = { "fields": ["dueAt", "name", "priority"] }
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({fields: ['dueAt', 'name', 'priority']})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order', 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/field-order",
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([
'fields' => [
'dueAt',
'name',
'priority'
]
]),
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/field-order"
payload := strings.NewReader("{\n \"fields\": [\n \"dueAt\",\n \"name\",\n \"priority\"\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/field-order")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": [\n \"dueAt\",\n \"name\",\n \"priority\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order")
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 \"fields\": [\n \"dueAt\",\n \"name\",\n \"priority\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"uuid": "<string>",
"name": "<string>",
"position": 123
}
]
}{
"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
Reorder fields
Sets the order of a board’s fields. Send the field uuids in the order you want in fields.
The listed fields swap among the positions they already hold, so fields you leave out, and the
board’s field groups, stay where they are. List every field to reorder the whole board.
Sending the current order changes nothing. Locked fields can be moved too. Refused (400) for an
unknown or repeated uuid. Returns every field of the board in its new order.
Requires update permission and “Edit Boards” access (not needed on a board that same key
created).
PUT
/
api
/
board
/
{boardId}
/
configuration
/
field-order
Reorder fields
curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"fields": [
"dueAt",
"name",
"priority"
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order"
payload = { "fields": ["dueAt", "name", "priority"] }
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({fields: ['dueAt', 'name', 'priority']})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order', 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/field-order",
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([
'fields' => [
'dueAt',
'name',
'priority'
]
]),
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/field-order"
payload := strings.NewReader("{\n \"fields\": [\n \"dueAt\",\n \"name\",\n \"priority\"\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/field-order")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"fields\": [\n \"dueAt\",\n \"name\",\n \"priority\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/field-order")
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 \"fields\": [\n \"dueAt\",\n \"name\",\n \"priority\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
{
"uuid": "<string>",
"name": "<string>",
"position": 123
}
]
}{
"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
Path Parameters
Body
application/json
Field uuids in the order you want them.
Required array length:
2 - 500 elementsExample:
["dueAt", "name", "priority"]
Response
The board's fields in their new order.
Show child attributes
Show child attributes