Create items in bulk

Adds different types of items to a board. You can add up to 20 items of the same or different type per create call. For example, you can create 3 shape items, 4 card items, and 5 sticky notes in one create call. The bulk create operation is transactional. If any item's create operation fails, the create operation for all the remaining items also fails, and none of the items will be created.

To try out this API in our documentation:

1. In the BODY PARAMS section, scroll down until you see ADD OBJECT (Figure 1).

“add
Figure 1. Add object user interface in readme

2. Click ADD OBJECT, and then select or enter the appropriate values for parameters of the item that you want to add.

3. Repeat steps 1 and 2 for each item that you want to add.

Required scope

boards:write

Rate limiting

Level 2 per item. For example, if you want to create one sticky note, one card, and one shape item in one call, the rate limiting applicable will be 300 credits. This is because create item calls take Level 2 rate limiting of 100 credits each, 100 for sticky note, 100 for card, and 100 for shape item.

Log in to see full request history
Path Params
string
required

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

Body Params
string
required

Type of item that you want to create.

data
object

Contains data information applicable for each item type.

style
object

Contains information about item-specific styles.

position
object

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

geometry
object

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

parent
object

Contains information about the parent this item must be attached to. A maximum of 5000 items can be attached to a frame. Passing null for parent.id directly attaches an item to the canvas.

Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json