Update a field group
curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid} \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"fieldUuids": [
"<string>"
],
"required": true,
"pinned": true
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid}"
payload = {
"name": "<string>",
"description": "<string>",
"fieldUuids": ["<string>"],
"required": True,
"pinned": 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>',
description: '<string>',
fieldUuids: ['<string>'],
required: true,
pinned: true
})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid}', 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/groups/{groupUuid}",
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>',
'description' => '<string>',
'fieldUuids' => [
'<string>'
],
'required' => true,
'pinned' => 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/groups/{groupUuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldUuids\": [\n \"<string>\"\n ],\n \"required\": true,\n \"pinned\": true\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/groups/{groupUuid}")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldUuids\": [\n \"<string>\"\n ],\n \"required\": true,\n \"pinned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid}")
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 \"description\": \"<string>\",\n \"fieldUuids\": [\n \"<string>\"\n ],\n \"required\": true,\n \"pinned\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"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 group
Changes a group’s name, description (an empty string clears it), fieldUuids, required or
pinned. Only the properties you send change; the group’s subgroups and auto-assignment are left
as they are. fieldUuids replaces the group’s field list, so send the full list in the order you
want. Requires update permission and “Edit Boards” access (not needed on a board that same key
created).
PUT
/
api
/
board
/
{boardId}
/
configuration
/
groups
/
{groupUuid}
Update a field group
curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid} \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"name": "<string>",
"description": "<string>",
"fieldUuids": [
"<string>"
],
"required": true,
"pinned": true
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid}"
payload = {
"name": "<string>",
"description": "<string>",
"fieldUuids": ["<string>"],
"required": True,
"pinned": 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>',
description: '<string>',
fieldUuids: ['<string>'],
required: true,
pinned: true
})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid}', 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/groups/{groupUuid}",
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>',
'description' => '<string>',
'fieldUuids' => [
'<string>'
],
'required' => true,
'pinned' => 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/groups/{groupUuid}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldUuids\": [\n \"<string>\"\n ],\n \"required\": true,\n \"pinned\": true\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/groups/{groupUuid}")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"fieldUuids\": [\n \"<string>\"\n ],\n \"required\": true,\n \"pinned\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/groups/{groupUuid}")
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 \"description\": \"<string>\",\n \"fieldUuids\": [\n \"<string>\"\n ],\n \"required\": true,\n \"pinned\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {}
}{
"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 group.