Skip to main content
POST
Add a mirror field

Authorizations

x-token
string
header
required

Headers

x-company-id
string

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.

Path Parameters

boardId
string
required

The board that gets the mirror field.

Body

application/json
targetBoardUuid
string
required

The uuid of the board to mirror a field from.

targetFieldUuid
string
required

The uuid of the field on that board to mirror.

name
string

Display name for the new field. Defaults to Mirror <target field name>.

readOnly
boolean

Whether users may edit the mirrored value on this board. Defaults to true.

Response

The created field.

data
object