Request
Basic information
| Field | Value |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/notable/bases/{baseId}/sheets/{sheetIdOrName} |
| HTTP Method | PUT |
| Supported app type | appType-Internal app |
| Required permission | permission-Notable.Base.Write.All-AI Table app write permission |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Yes | The access credential for calling this API. To obtain it, call the Get the access token of an internal app API. |
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
| baseId | String | Yes | The ID of the AI Table. For details on how to obtain it, see Data structure. |
| sheetIdOrName | String | Yes | The ID or name of the table. You can obtain the table ID in either of the following ways: - Call the Get all tables API. - Call the Get a table API. |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
| operatorId | String | Yes | The unionId of the operator. You can obtain it in either of the following ways: - Call the Query user details API. - Call the Get user information by silent login code API. |
Request body
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Yes | The new name of the table. |
Request example
HTTPResponse
Response body
| Name | Type | Description |
|---|---|---|
| id | String | The ID of the table. |
| name | String | The name of the table. |
Response body example
Error codes
If an error is returned when you call this API, look up the solution in the Global error codes document based on the error message.| HttpCode | Error code | Error message | Description |
|---|---|---|---|
| 500 | internalError | The server encountered an internal error and was unable to complete your request. Please try again later. | System error. |
| 500 | unknownError | Unknown Error | Unknown error. |
| 400 | invalidRequest.inputArgs.invalid | %s | Invalid request parameter. Refer to the error message for details. |
| 400 | invalidRequest.document.stillInitializing | The document is under initialization. Please try again later | The document is initializing. Try again later. |
| 400 | invalidRequest.document.broken | The document is broken and the server is unable to complete your request. | The document is corrupted. |
| 403 | forbidden.operationIllegal | %s | No permission. |
| 403 | invalidRequest.document.typeIllegal | %s | Unsupported document type. Check the baseId. |
| 404 | invalidRequest.document.notFound | Fail to find the requested resource by the given baseId. Please make sure the given baseId is valid, and the operatorId has permission to access it. | The document does not exist. |
| 404 | invalidRequest.resource.notFound | %s | The resource does not exist. The data does not exist or has been permanently deleted. |
| 504 | service.timeout | The server is busy and unable to complete your request. Please try again later. | Request timed out. |