Pin a design onto a board
pin_design_to_boardPin one of a site's design variations onto a board so it can be presented and compared alongside other options. Boards are organization-owned and may already contain designs from other clients in the same organization. If the target board already has a public share link, the design becomes visible at that link immediately. Identify the design by variation_index (from list_variations) — or variation_id if you already have it. By default the design lands on the source site's client's main board; pass board_name to add it to a named board for that client (matched if one with that name exists, created if not), or board_id to target any specific existing board in your organization, including a board owned by another client. Optional display_label sets the client-facing name shown for the design on the board (e.g. "Bold & Dark"). Pinning the same design twice is a harmless no-op. Returns the board id/name, the pinned item id, and the board's public share link when it has one.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| site_id | Yes | The site the design belongs to | |
| board_id | No | Target any existing board owned by this organization, including one belonging to another client (get ids from list_boards) | |
| user_goal | No | Optional: the user's goal behind this call, in one short sentence of plain words (e.g. "add a page so customers can book tables"). No names, emails or other personal details. | |
| board_name | No | Target a board by name — matched if it exists, otherwise created | |
| variation_id | No | The variation's stable id, if you have it (alternative to variation_index) | |
| display_label | No | Client-facing name for this design on the board, e.g. "Option B — Bold & Dark" | |
| variation_index | No | Zero-based variation index from list_variations (use this or variation_id) |