Skip to main content

Create text item

POST 
/v2/boards/:board_id/texts

Adds a text item to a board.

Required scope

boards:write

Rate limiting

Level 2

Request​

Path Parameters

    board_id stringrequired

    Unique identifier (ID) of the board where you want to create the item.

Body

required

    data

    object

    required

    Contains text item data, such as the title, content, or description. For more information on the JSON properties, see Data.

    content stringrequired

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

    style

    object

    Contains information about the style of a text item, such as the fill color or font family.

    color string

    Hex value representing the color for the text within the text item. Default: #1a1a1a.

    fillColor string

    Background color of the text item. Default: #ffffff.

    fillOpacity string

    Possible values: <= 1

    Opacity level of the background color. Possible values: any number between 0.0 and 1.0, where: 0.0: the background color is completely transparent or invisible. 1.0: the background color is completely opaque or solid. Default: 1.0 if fillColor is provided, 0.0 if fillColor is not provided.

    fontFamily string

    Possible values: [arial, abril_fatface, bangers, eb_garamond, georgia, graduate, gravitas_one, fredoka_one, nixie_one, open_sans, permanent_marker, pt_sans, pt_sans_narrow, pt_serif, rammetto_one, roboto, roboto_condensed, roboto_slab, caveat, times_new_roman, titan_one, lemon_tuesday, roboto_mono, noto_sans, plex_sans, plex_serif, plex_mono, spoof, tiempos_text, formular]

    Font type for the text in the text item. Default: arial.

    fontSize string

    Possible values: >= 1

    Font size, in dp. Default: 14.

    textAlign string

    Possible values: [left, right, center]

    Horizontal alignment for the item's content. Default: center.

    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 rotation. You can only specify the width of the text item as the height is dynamically updated based on the content.

    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. The minimum width of a text widget is relative to the font size of the text widget. The width must be at least 1.7 times wider than the font size. For example, if the font size of the text item is 14, the minimum width is 24.

    parent

    object

    Contains information about the parent frame for the item.

    id int64

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

Responses​

Text item created

Schema

    id stringrequired

    Unique identifier (ID) of an item.

    data

    object

    Contains text item data, such as the title, content, or description. For more information on the JSON properties, see Data.

    content stringrequired

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

    style

    object

    Contains information about the style of a text item, such as the fill color or font family.

    color string

    Hex value representing the color for the text within the text item. Default: #1a1a1a.

    fillColor string

    Background color of the text item. Default: #ffffff.

    fillOpacity string

    Possible values: <= 1

    Opacity level of the background color. Possible values: any number between 0.0 and 1.0, where: 0.0: the background color is completely transparent or invisible. 1.0: the background color is completely opaque or solid. Default: 1.0 if fillColor is provided, 0.0 if fillColor is not provided.

    fontFamily string

    Possible values: [arial, abril_fatface, bangers, eb_garamond, georgia, graduate, gravitas_one, fredoka_one, nixie_one, open_sans, permanent_marker, pt_sans, pt_sans_narrow, pt_serif, rammetto_one, roboto, roboto_condensed, roboto_slab, caveat, times_new_roman, titan_one, lemon_tuesday, roboto_mono, noto_sans, plex_sans, plex_serif, plex_mono, spoof, tiempos_text, formular]

    Font type for the text in the text item. Default: arial.

    fontSize string

    Possible values: >= 1

    Font size, in dp. Default: 14.

    textAlign string

    Possible values: [left, right, center]

    Horizontal alignment for the item's content. Default: center.

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