curl --request DELETE \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
headers = {"x-token": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'x-token': '<api-key>'}};
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 => "DELETE",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}")
.header("x-token", "<api-key>")
.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::Delete.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"deleted": true
}
}Delete a field
Removes a field from the board (card values already stored for it are left in place). Refused
for standard fields (name, stage, description, tags, checklist, files,
lastAction, dueAt, relatedContacts), locked, mirror and integration-managed fields (403),
and - as in the Aptly app - for a field used by a saved filter, or by a workflow or automation
that runs off one (409 CONFLICT, with the dependents in meta). Requires update permission
and “Edit Boards” access (not needed on a board that same key created).
curl --request DELETE \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
headers = {"x-token": "<api-key>"}
response = requests.delete(url, headers=headers)
print(response.text)const options = {method: 'DELETE', headers: {'x-token': '<api-key>'}};
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 => "DELETE",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}"
req, _ := http.NewRequest("DELETE", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.delete("https://core-api.getaptly.com/api/board/{boardId}/configuration/fields/{fieldUuid}")
.header("x-token", "<api-key>")
.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::Delete.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "<string>",
"deleted": true
}
}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.