Skip to main content

Update sticky note item

PATCH 
/v2/boards/:board_id/sticky_notes/:item_id

Updates a sticky note item on a board based on the data and style 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 item.

    item_id stringrequired

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

Body

required

    data

    object

    Contains sticky note item data, such as the content or shape of the sticky note.

    content string

    The actual text (content) that appears in the sticky note item.

    shape string

    Possible values: [square, rectangle]

    Default value: square

    Defines the geometric shape of the sticky note and aspect ratio for its dimensions.

    style

    object

    Contains information about the style of a sticky note item, such as the fill color or text alignment.

    fillColor string

    Possible values: [gray, light_yellow, yellow, orange, light_green, green, dark_green, cyan, light_pink, pink, violet, red, light_blue, blue, dark_blue, black]

    Fill color for the sticky note. Default: light_yellow.

    textAlign string

    Possible values: [left, right, center]

    Defines how the sticky note text is horizontally aligned. Default: center.

    textAlignVertical string

    Possible values: [top, middle, bottom]

    Defines how the sticky note text is vertically aligned. Default: top.

    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. You can set either the width or height. You cannot set both the width and height at the same time.

    height double

    Height of the item, in pixels.

    width double

    Width of the item, in pixels.

    parent

    object

    Contains information about the parent frame for the item.

    id int64

    Unique identifier (ID) of the parent frame for the item.

Responses​

Sticky Note item updated

Schema

    id stringrequired

    Unique identifier (ID) of an item.

    data

    object

    Contains sticky note item data, such as the content or shape of the sticky note.

    content string

    The actual text (content) that appears in the sticky note item.

    shape string

    Possible values: [square, rectangle]

    Default value: square

    Defines the geometric shape of the sticky note and aspect ratio for its dimensions.

    style

    object

    Contains information about the style of a sticky note item, such as the fill color or text alignment.

    fillColor string

    Possible values: [gray, light_yellow, yellow, orange, light_green, green, dark_green, cyan, light_pink, pink, violet, red, light_blue, blue, dark_blue, black]

    Fill color for the sticky note. Default: light_yellow.

    textAlign string

    Possible values: [left, right, center]

    Defines how the sticky note text is horizontally aligned. Default: center.

    textAlignVertical string

    Possible values: [top, middle, bottom]

    Defines how the sticky note text is vertically aligned. Default: top.

    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.

    parent

    object

    Contains information about the parent frame for the item.

    id int64

    Unique identifier (ID) of the parent frame for the item.

    links

    object

    Contains applicable links for the current object.

    self string

    Link to obtain more information about the current object.

    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...