Create a board
Creates a new board. Requires the key's dedicated "Create Boards" access toggle to be enabled, in addition to insert permission — unlike the API key's other access toggles, this one defaults off and must be explicitly turned on in Setup → Developer.
A stage field is always added automatically (a board can't render a Kanban/pipeline view without one) — ticket boards default to To Do / In Progress / Done, deal boards to the standard Aptly deal pipeline. To use your own pipeline instead, pass stages. You can add, reorder and recolor stages later with PUT .../configuration/fields/stage. stage, along with a handful of other reserved keys (name, dueAt, relatedContacts, and every card-document system key such as _id, companyId, archived), can't be used as a custom field's uuid.
Only a safe, self-contained subset of Aptly's field types may be used for custom fields — relational types that reference other boards (e.g. relatedAptlets, mirror) and system/computed types the backend manages itself (e.g. stageselect, calculation) are rejected, since a freshly created board has nothing valid for them to point at yet.
The key that creates a board keeps access to it. Even if the key is limited to specific boards (so the new board is not on its list), it can read and write the board's cards, see it in GET /api/boards, and - with the update permission but without the "Edit Boards" toggle - add, change and remove its fields, change its theme and archive it. This applies only to boards created through this endpoint by that key, and ends when the key is deleted. It does not extend to other boards, to creating Automations (which has its own toggle), or to Tasks, Files and mirror-field links to other boards, which still follow the key's board list. Boards created before this change are not affected.
Request
- Base URLhttps://core-api.getaptly.com
- Auth
- API key in header x-token
- or API key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"stages": [
{
"color": "#1ec968"
}
]
}Response
Board created.
Changes
No recorded changes to this operation across all 1 revision of this API.