Board

Update a field

Updates a field's name, optional, pinned, startCard, defaultValue and - for select-type fields - its full data option list. A field's type and uuid never change. Options re-sent by label keep their uuid. Refused (403) for locked fields - except startCard, which any field accepts - and the options of integration-managed fields. Requires update permission and "Edit Boards" access (not needed on a board that same key created).

Renaming a field also rewrites its Board["Field"] merge tokens in the company's templates (best-effort: a failure there never fails the update).

Editing the stage pipeline (fieldUuid = stage): send the full data list in the order you want. You can add stages, reorder them and recolor them. Existing stages are matched by uuid (or by label when you leave uuid out) and keep their uuid. A stage that isn't matched is added: it gets a new uuid and may set color, closed and won (won is for deal boards only and implies closed). Cards, automations and saved filters refer to stages by name, so these are refused with 403: leaving an existing stage out (removing it), changing an existing stage's label (renaming it) and changing an existing stage between open, closed and won. The first stage is where new cards start, so whichever stage ends up first must be open (unless it was already first). Labels must be unique and there can be at most 30 stages. Board views that are open in the Aptly app refresh to show the change.

put/api/board/{boardId}/configuration/fields/{fieldUuid}

Request

Path parameters

boardIdstring required
fieldUuidstring required

Request body

namestring
optionalboolean
pinnedboolean
startCardboolean

Show the field on the form when a card is created.

defaultValuestring

Example request

{
  "data": [
    {
      "color": "#1ec968"
    }
  ]
}

Response

The updated field.

Changes

No recorded changes to this operation across all 1 revision of this API.