Set the create-card form order
curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-order \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"order": [
"tenantName",
"contactGroup",
"dueAt"
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-order"
payload = { "order": ["tenantName", "contactGroup", "dueAt"] }
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({order: ['tenantName', 'contactGroup', 'dueAt']})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-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/start-card-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([
'order' => [
'tenantName',
'contactGroup',
'dueAt'
]
]),
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/start-card-order"
payload := strings.NewReader("{\n \"order\": [\n \"tenantName\",\n \"contactGroup\",\n \"dueAt\"\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/start-card-order")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"order\": [\n \"tenantName\",\n \"contactGroup\",\n \"dueAt\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-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 \"order\": [\n \"tenantName\",\n \"contactGroup\",\n \"dueAt\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
"<string>"
]
}{
"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
Set the create-card form order
Replaces the order of the create-card form with order: field and group uuids, first to last.
Every uuid must be a field or group on the board and may appear once (400 otherwise). Items you
leave out sort after the listed ones, and an empty list restores the default order. This only
orders the form; use each field’s startCard flag to choose which fields appear. Requires
update permission and “Edit Boards” access (not needed on a board that same key created).
PUT
/
api
/
board
/
{boardId}
/
configuration
/
start-card-order
Set the create-card form order
curl --request PUT \
--url https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-order \
--header 'Content-Type: application/json' \
--header 'x-token: <api-key>' \
--data '
{
"order": [
"tenantName",
"contactGroup",
"dueAt"
]
}
'import requests
url = "https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-order"
payload = { "order": ["tenantName", "contactGroup", "dueAt"] }
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({order: ['tenantName', 'contactGroup', 'dueAt']})
};
fetch('https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-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/start-card-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([
'order' => [
'tenantName',
'contactGroup',
'dueAt'
]
]),
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/start-card-order"
payload := strings.NewReader("{\n \"order\": [\n \"tenantName\",\n \"contactGroup\",\n \"dueAt\"\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/start-card-order")
.header("x-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"order\": [\n \"tenantName\",\n \"contactGroup\",\n \"dueAt\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/board/{boardId}/configuration/start-card-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 \"order\": [\n \"tenantName\",\n \"contactGroup\",\n \"dueAt\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": [
"<string>"
]
}{
"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 and group uuids in the order you want them.
Maximum array length:
500Example:
["tenantName", "contactGroup", "dueAt"]
Response
The saved order.