curl --request DELETE \
--url https://core-api.getaptly.com/api/board/{boardId} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}"
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}', 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}",
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}"
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}")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}")
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>",
"archived": true,
"cardsArchived": 123
}
}Archive a board
Archives the board, as the Archive action in the Aptly app does: the board, all of its cards,
its saved filters and its communication templates are archived, and the cards’ open tasks are
closed out. Nothing is hard-deleted, but there is no API to un-archive, and an archived board
stops resolving through the API (404). Requires update permission and the key’s “Edit
Boards” access.
curl --request DELETE \
--url https://core-api.getaptly.com/api/board/{boardId} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}"
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}', 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}",
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}"
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}")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}")
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>",
"archived": true,
"cardsArchived": 123
}
}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.