1. Docs
2. /
3. Tool reference
4. /
5. Pages & Spaces
6. /
7. insertComponent

Pages & Spaces

insertComponent

Insert Component

Place a real typed component: a status chip: into a page body at a chosen anchor.

write

Arguments

• pageIdstringrequiredThe page ID to place the component in
• componentTypestringrequiredThe component to author. Only "statusChip" is available.
• labelstringrequiredThe chip text, e.g. "Todo", "In review", "Done". Trimmed; capped at 40 characters.
• colorstringoptionalChip colour from the status palette. Defaults to gray. Use green for done/positive, red for blocked, amber for in-review, blue for in-progress.
• positionstringrequiredWhere to place the chip: pageStart (top of page), afterHeading (right after a heading), beforeBlock or afterBlock (relative to a block matched by its text), or inTableCell (inside a specific cell of a table).
• matchstringoptionalFor afterHeading: the heading's text. For beforeBlock or afterBlock: text the target block contains. Omit for pageStart and inTableCell.
• tableMatchstringoptionalFor inTableCell only: text the target table contains (e.g. a header label or a cell value) to locate it. Required when position is inTableCell.
• rowIndexintegeroptionalFor inTableCell only: the 0-indexed row (row 0 is the header row). Required when position is inTableCell.
• colIndexintegeroptionalFor inTableCell only: the 0-indexed column. Required when position is inTableCell.
• replaceCellContentbooleanoptionalFor inTableCell only: replace the cell's existing text/emoji with the chip so the chip is the cell's sole content: the one-step way to convert an emoji/text column into chips. Omit (or false) to add the chip inline alongside the cell's…

Returns

It returns a componentId; keep it to re-style the same chip later with updateComponent.

Declared limits

• rowIndex: minimum 0
• rowIndex: maximum 9007199254740991
• colIndex: minimum 0
• colIndex: maximum 9007199254740991

Ask for it

The Cloud routes these requests to this verb.

• add a status chip
• mark this as in progress
• drop a Done pill after the heading
• put a blocked tag on the page
• set the status cell in that table to Shipped

Pair it with

The verbs that finish the job.

• updateComponent
• insertContent
• readPage