Skip to main content

Update frame

PATCH 
/v2/boards/:board_id/frames/:item_id

Updates a frame on a board based on the data, style, or geometry properties provided in the request body.

Required scope

boards:write

Rate limiting

Level 2

Request​

Path Parameters

    board_id stringrequired

    Unique identifier (ID) of the board where you want to update the frame.

    item_id stringrequired

    Unique identifier (ID) of the frame that you want to update.

Body

required

    data

    object

    Contains frame item data, such as the title, frame type, or frame format.

    format string

    Possible values: [custom]

    Default value: custom

    Only custom frames are supported at the moment.

    title string

    Default value: Sample frame title

    Title of the frame. This title appears at the top of the frame.

    type string

    Possible values: [freeform]

    Default value: freeform

    Only free form frames are supported at the moment.

    showContent boolean

    Default value: true

    Hide or reveal the content inside a frame (Enterprise plan only).

    style

    object

    Contains information about the style of a frame item, such as the fill color.

    fillColor string

    Fill color for the frame. Hex values: #f5f6f8 #d5f692 #d0e17a #93d275 #67c6c0 #23bfe7 #a6ccf5 #7b92ff #fff9b1 #f5d128 #ff9d48 #f16c7f #ea94bb #ffcee0 #b384bb #000000 Default: #ffffffff (transparent).

    position

    object

    Contains information about the item's position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

    x double

    X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

    y double

    Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

    geometry

    object

    Contains geometrical information about the item, such as its width or height.

    height double

    Height of the item, in pixels.

    width double

    Width of the item, in pixels.

Responses​

Frame updated

Schema

    id stringrequired

    Unique identifier (ID) of an item.

    data

    object

    Contains frame item data, such as the title, frame type, or frame format.

    format string

    Possible values: [custom, desktop, phone, tablet, a4, letter, ratio_1x1, ratio_4x3, ratio_16x9]

    Default value: custom

    Only custom frames are supported at the moment.

    title string

    Title of the frame. This title appears at the top of the frame.

    type string

    Possible values: [freeform, heap, grid, rows, columns]

    Default value: freeform

    Only free form frames are supported at the moment.

    style

    object

    Contains information about the style of a frame item, such as the fill color.

    fillColor string

    Fill color for the frame. Hex values: #f5f6f8 #d5f692 #d0e17a #93d275 #67c6c0 #23bfe7 #a6ccf5 #7b92ff #fff9b1 #f5d128 #ff9d48 #f16c7f #ea94bb #ffcee0 #b384bb #000000 Default: #ffffffff (transparent).

    position

    object

    Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

    origin string

    Possible values: [center]

    Default value: center

    Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates. Currently, only one option is supported.

    relativeTo string

    Possible values: [canvas_center, parent_top_left]

    x double

    X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

    y double

    Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

    geometry

    object

    Contains geometrical information about the item, such as its width or height.

    height double

    Height of the item, in pixels.

    rotation double

    Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.

    width double

    Width of the item, in pixels.

    createdAt date-time

    Date and time when the item was created.
    Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    createdBy

    object

    Contains information about the user who created the item.

    id string

    Unique identifier (ID) of the user.

    type string

    Indicates the type of object returned. In this case, type returns user.

    modifiedAt date-time

    Date and time when the item was last modified.
    Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    modifiedBy

    object

    Contains information about the user who last modified the item.

    id string

    Unique identifier (ID) of the user.

    type string

    Indicates the type of object returned. In this case, type returns user.

    links

    object

    Contains applicable links for the item.

    related string

    Link to obtain information about the child items related to the frame.

    self string

    Link to obtain information about the current item.

    type stringrequired

    Type of item that is returned.

Loading...