Blocks

Edit a block

Changes one block. params is replaced whole, so send the ones you want kept; anything you omit falls back to its default. Params we do not describe are left alone. top and left move it on the canvas; omit them and it stays where it was drawn.

This endpoint carries no connections, so removing a button or an exit that a connection leaves from is refused. Use PATCH /bots/{bot_id}/draft to do both at once.

patch/bots/{bot_id}/draft/blocks/{block_id}

Request

  • Base URL: https://api.landbot.io/v0-alpha
  • URL: https://api.landbot.io/v0-alpha/bots/{bot_id}/draft/blocks/{block_id}
  • Auth: one of:
    • API key in header Authorization
    • API key in cookie sessionid
    • HTTP bearer

Request body

namestring nullable

Send null to remove the label.

paramsobject

Replaces the block's params as a whole.

topinteger

How far down the builder's canvas to move the block. Omitted, it stays where it is.

leftinteger

How far across the builder's canvas to move the block. Omitted, it stays where it is.

Response

The draft after the change

Example response

{
  "data": {
    "diagram": {
      "nodes": {
        "hidden": {
          "id": "hidden",
          "path": "hidden",
          "template": "hidden",
          "params": {}
        },
        "welcome": {
          "id": "welcome",
          "path": "welcome",
          "template": "var_text",
          "params": {
            "version": 3,
            "text": "Hi! What is your name?",
            "destination": "name"
          }
        }
      },
      "connections": {
        "hidden.success--welcome": {
          "id": "hidden.success--welcome",
          "type": "success",
          "sourcePath": "hidden",
          "targetPath": "welcome"
        }
      }
    },
    "edited_at": "2026-09-16T09:18:19"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.