# Update SQL workbook name

Modifying the name of the SQL saved record will not modify the SQL content or version saved therein.

```text
POST $CLOUDSIGMA_API_BASE/workbook/update
```

## Before you call this API

Configure the [regional API endpoint and authentication](https://omnifabric.cloudsigma.com/docs/developer/endpoints-and-authentication.html.md), and select the target workspace.

First [list saved SQL records](https://omnifabric.cloudsigma.com/docs/reference/api/ai-studio/data-processing/sql-workbooks/list-workbooks.html.md) to obtain the `workbook_id`.

`$WORKBOOK_ID` in the example below is the ID of the SQL saved record and `$WORKBOOK_NAME` is the new name.

## Request body

Replace caller-specific values in the example with actual values.

::::{div} mo-api-split
:::{div} mo-api-split-main
<dl class="mo-api-fields">
<div class="mo-api-field"><dt><code>workbook_id</code><span class="mo-api-field__type">string</span><span class="mo-api-field__required">Required</span></dt><dd>The ID of the SQL saved record.</dd></div>
<div class="mo-api-field"><dt><code>name</code><span class="mo-api-field__type">string</span><span class="mo-api-field__required">Required</span></dt><dd>New name.</dd></div>
</dl>
:::
:::{div} mo-api-split-aside
<p class="mo-api-example-label">Request example</p>
```bash
curl -X POST "$CLOUDSIGMA_API_BASE/workbook/update" \
  -H "X-API-Key: $CLOUDSIGMA_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H 'Content-Type: application/json' \
  -d "{
    \"workbook_id\": \"$WORKBOOK_ID\",
    \"name\": \"$WORKBOOK_NAME\"
  }"
```
:::
::::
## Successful response

`data` is empty on success. You can then [View saved SQL](https://omnifabric.cloudsigma.com/docs/reference/api/ai-studio/data-processing/sql-workbooks/list-workbooks.html.md) confirm the new name.

```json
{
  "code": 200,
  "data": null
}
```

The response fields are as follows.

| Field | Type | Description |
| --- | --- | --- |
| `data` | null | Fixed to `null` when the update is successful. |

## Error response

::::{div} mo-api-split
:::{div} mo-api-split-main
<dl class="mo-api-fields">
<div class="mo-api-field"><dt><code>code</code><span class="mo-api-field__type">integer or string</span></dt><dd>Error code or status.</dd></div>
<div class="mo-api-field"><dt><code>message</code><span class="mo-api-field__type">string</span></dt><dd>Error message.</dd></div>
</dl>
:::
:::{div} mo-api-split-aside
<p class="mo-api-example-label">Error response example</p>
```json
{
  "code": 404,
  "message": "SQL 工作簿不存在"
}
```
:::
::::
## Follow-up operations

Use the same resource identifier [View saved SQL version content](https://omnifabric.cloudsigma.com/docs/reference/api/ai-studio/data-processing/sql-workbooks/get-workbook.html.md) to confirm the update result.
