curl --request POST \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"targetBoardUuid": "deals",
"targetFieldUuid": "rent",
"name": "Deal rent"
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields"
payload = {
"targetBoardUuid": "deals",
"targetFieldUuid": "rent",
"name": "Deal rent"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetBoardUuid: 'deals', targetFieldUuid: 'rent', name: 'Deal rent'})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields', 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/mirror-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'targetBoardUuid' => 'deals',
'targetFieldUuid' => 'rent',
'name' => 'Deal rent'
]),
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/mirror-fields"
payload := strings.NewReader("{\n \"targetBoardUuid\": \"deals\",\n \"targetFieldUuid\": \"rent\",\n \"name\": \"Deal rent\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetBoardUuid\": \"deals\",\n \"targetFieldUuid\": \"rent\",\n \"name\": \"Deal rent\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetBoardUuid\": \"deals\",\n \"targetFieldUuid\": \"rent\",\n \"name\": \"Deal rent\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "Qk3x9TnWc2LmPa8vR",
"name": "Deal rent",
"type": "money",
"optional": true,
"pinned": false,
"position": 12,
"readOnly": true,
"metricField": false,
"mirrorTarget": {
"targetAptletUuid": "deals",
"targetFieldUuid": "rent"
}
}
}{
"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>"
}Add a mirror field
Adds a field to the board that mirrors a field of another board. The new field takes the
target field’s type (and, for select types, a copy of its option list), is named
Mirror <target field name> unless you supply name, and is read-only unless you set
readOnly: false.
This only adds the field - the same as the Aptly app. A card shows a mirrored value once it is linked to a card on the target board (for example through a related-cards field) and is next saved; existing cards are not backfilled when the field is added.
Requires update permission and the key’s “Edit Boards” access (off by default). A key’s
board allowlist applies to both boards: the target board must be one the key can access
and must be API-enabled. The target field must be one of string, text, rich-text,
address, email, url, datetime-local, date, number, percent, stageselect,
singleselect, multiselect, tags, boolean, person, persons, relatedAptlets,
files, file, money, user or lockAlias, and can’t itself be a mirror field. Mirroring
the same target field twice on one board returns 409.
curl --request POST \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"targetBoardUuid": "deals",
"targetFieldUuid": "rent",
"name": "Deal rent"
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields"
payload = {
"targetBoardUuid": "deals",
"targetFieldUuid": "rent",
"name": "Deal rent"
}
headers = {
"x-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({targetBoardUuid: 'deals', targetFieldUuid: 'rent', name: 'Deal rent'})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields', 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/mirror-fields",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'targetBoardUuid' => 'deals',
'targetFieldUuid' => 'rent',
'name' => 'Deal rent'
]),
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/mirror-fields"
payload := strings.NewReader("{\n \"targetBoardUuid\": \"deals\",\n \"targetFieldUuid\": \"rent\",\n \"name\": \"Deal rent\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"targetBoardUuid\": \"deals\",\n \"targetFieldUuid\": \"rent\",\n \"name\": \"Deal rent\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/mirror-fields")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"targetBoardUuid\": \"deals\",\n \"targetFieldUuid\": \"rent\",\n \"name\": \"Deal rent\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"uuid": "Qk3x9TnWc2LmPa8vR",
"name": "Deal rent",
"type": "money",
"optional": true,
"pinned": false,
"position": 12,
"readOnly": true,
"metricField": false,
"mirrorTarget": {
"targetAptletUuid": "deals",
"targetFieldUuid": "rent"
}
}
}{
"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>"
}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.