# Update a record
Update a record
For the first access, please refer to [Cloud Document Interface QuickStart](https://open.feishu.cn/document/ukTMukTMukTM/uczNzUjL3czM14yN3MTN) & [Base OpenAPI Access Guide](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification)
## Request
Facts |
---|---
HTTP URL | https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/tables/:table_id/records/:record_id
HTTP Method | PUT
Rate Limit | [50 per second](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
Supported app types | Custom App、Store App
Required scopes
**To use this API, you must have at least 1 of the listed scopes.**
Enable any scope from the list | 更新记录(base:record:update)
View, comment, edit and manage Base(bitable:app)
Required field scopes | **Notice**：The response body of the API contains the following sensitive fields, and they will be returned only after corresponding scopes are added. If you do not need the fields, it is not recommended that you request the scopes.
Obtain user's basic information(contact:user.base:readonly)
Obtain user ID(contact:user.employee_id:readonly)
Access Contacts as an app(contact:contact:access_as_app)
Read contacts(contact:contact:readonly)
Read Contacts as an app(contact:contact:readonly_as_app)
### Request header
Parameter | Type | Required | Description
---|---|---|---
Authorization | string | Yes | `tenant_access_token`
or
`user_access_token`
**Value format**: "Bearer `access_token`"
**Example value**: "Bearer u-7f1bcd13fc57d46bac21793a18e560"
[How to choose and get access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | Yes | **Fixed value**: "application/json; charset=utf-8"
### Path parameters
Parameter | Type | Description
---|---|---
app_token | string | Base unique device identifier [app_token description](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#8121eebe)
**Example value**: "appbcbWCzen6D8dezhoCH2RpMAh"
table_id | string | Base data table unique device identifier [table_id description](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/bitable/notification#735fe883)
**Example value**: "tblsRc9GRRXKqhvW"
record_id | string | record_id
**Example value**: "recPGfZZ13"
### Query parameters
Parameter | Type | Required | Description
---|---|---|---
user_id_type | string | No | User ID categories
**Example value**: open_id
**Optional values are**:
- open_id：Identifies a user to an app. The same user has different Open IDs in different apps. [How to get Open ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-openid)
- union_id：Identifies a user to a tenant that acts as a developer. A user has the same Union ID in apps developed by the same developer, and has different Union IDs in apps developed by different developers. A developer can use Union ID to link the same user's identities in multiple apps.[How to get Union ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-union-id)
- user_id：Identifies a user to a tenant. The same user has different User IDs in different tenants. In one single tenant, a user has the same User ID in all apps （including store apps）. User ID is usually used to communicate user data between different apps. [How to get User ID](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-obtain-user-id)
**Default value**: `open_id`
**When the value is `user_id`, the following field scopes are required**:
Obtain user ID(contact:user.employee_id:readonly)
ignore_consistency_check | boolean | No | Whether to ignore consistency checks for read and write operations. The default value is `false`, meaning the system will ensure that the data read and written is consistent. Optional values:
- **true**: Ignore read/write consistency checks to improve performance, but this may cause data on some nodes to be out of sync, resulting in temporary inconsistency.
- **false**: Enable read/write consistency checks to ensure data consistency during read and write operations.
**Example value**: true
### Request body
Parameter | Type | Required | Description
---|---|---|---
fields | map<string, union> | Yes | fields
**Example value**: {"multiline":"HelloWorld"}
### Request body example
```json
{
"fields": {
"text": "text",
"barcode":"qawqe",
"number": 100,
"currency":3,
"rating":3,
"progress":0.25,
"single_select": "option_1",
"multi_select": ["option_1", "option_2"],
"date": 1674206443000,
"checkbox": true,
"user": [{
"id": "ou_2910013f1e6456f16a0ce75ede950a0a"
}, {
"id": "ou_e04138c9633dd0d2ea166d79f548ab5d"
}],
"groupChat":[
{
"id": "oc_cd07f55f14d6f4a4f1b51504e7e97f48"
}
],
"phone": "130xxxx2666",
"url": {
"text": "Base",
"link": "https://www.feishu.cn/product/base"
},
"attachment": [{
"file_token": "DRiFbwaKsoZaLax4WKZbEGCccoe"
}, {
"file_token": "BZk3bL1Enoy4pzxaPL9bNeKqcLe"
}, {
"file_token": "EmL4bhjFFovrt9xZgaSbjJk9c1b"
}, {
"file_token": "Vl3FbVkvnowlgpxpqsAbBrtFcrd"
}],
"single_link": ["recHTLvO7x", "recbS8zb2m"],
"duplex_link": ["recHTLvO7x", "recbS8zb2m"],
"location": "116.397755,39.903179"
}
}
```
## Response
### Response body
Parameter | Type | Description
---|---|---
code | int | Error codes, fail if not zero
msg | string | Error descriptions
data | \- | \-
record | app.table.record | record
fields | map<string, union> | fields
record_id | string | record id，Update records are required
created_by | person | record creator
id | string | user id
name | string | user name
en_name | string | user english name
email | string | user email
avatar_url | string | user avatar url
**Required field scopes (Satisfy any)**:
Obtain user's basic information(contact:user.base:readonly)
Access Contacts as an app(contact:contact:access_as_app)
Read contacts(contact:contact:readonly)
Read Contacts as an app(contact:contact:readonly_as_app)
created_time | int | record create timestamp
last_modified_by | person | the person who last modified the record
id | string | user id
name | string | user name
en_name | string | user english name
email | string | user email
avatar_url | string | user avatar url
**Required field scopes (Satisfy any)**:
Obtain user's basic information(contact:user.base:readonly)
Access Contacts as an app(contact:contact:access_as_app)
Read contacts(contact:contact:readonly)
Read Contacts as an app(contact:contact:readonly_as_app)
last_modified_time | int | record last modified timestamp
shared_url | string | shared link
record_url | string | record link
### Response body example
```json
{
"code": 0,
"data": {
"record": {
"fields": {
"text": "text",
"barcode": "qawqe",
"number": 100,
"currency":3,
"rating":3,
"progress":0.25,
"single_select": "option_1",
"multi_select": ["option_1", "option_2"],
"date": 1674206443000,
"checkbox": true,
"user": [{
"id": "ou_2910013f1e6456f16a0ce75ede950a0a"
}, {
"id": "ou_e04138c9633dd0d2ea166d79f548ab5d"
}],
"groupChat": [
{
"id": "oc_cd07f55f14d6f4a4f1b51504e7e97f48"
}
],
"phone": "13026162666",
"url": {
"text": "Base",
"link": "https://www.feishu.cn/product/base"
},
"attachment": [{
"file_token": "DRiFbwaKsoZaLax4WKZbEGCccoe"
}, {
"file_token": "BZk3bL1Enoy4pzxaPL9bNeKqcLe"
}, {
"file_token": "EmL4bhjFFovrt9xZgaSbjJk9c1b"
}, {
"file_token": "Vl3FbVkvnowlgpxpqsAbBrtFcrd"
}],
"single_link": ["recHTLvO7x", "recbS8zb2m"],
"duplex_link": ["recHTLvO7x", "recbS8zb2m"],
"location": "116.397755,39.903179"
},
"id": "reclAqylTN",
"record_id": "reclAqylTN"
}
},
"msg": "success"
}
```
### Error code
HTTP status code | Error code | Description | Troubleshooting suggestions
---|---|---|---
200 | 1254000 | WrongRequestJson | Request error
200 | 1254001 | WrongRequestBody | Request body error
200 | 1254002 | Fail | Internal error, have any questions can be consulting service
200 | 1254003 | WrongBaseToken | AppToken error
200 | 1254004 | WrongTableId | Table id wrong
200 | 1254005 | WrongViewId | View id wrong
200 | 1254006 | WrongRecordId | Record id wrong
200 | 1254007 | EmptyValue | Empty value
200 | 1254008 | EmptyView | Empty view
200 | 1254009 | WrongFieldId | Wrong fieldId
200 | 1254010 | ReqConvError | Request error
400 | 1254015 | Field types do not match. | Field types do not match.
403 | 1254027 | UploadAttachNotAllowed | Attachments don't belong to the app, not allowed to upload
200 | 1254030 | TooLargeResponse | TooLargeResponse
400 | 1254036 | Base is copying, please try again later. | Base copy replicating, try again later
200 | 1254040 | BaseTokenNotFound | AppToken not found
200 | 1254041 | TableIdNotFound | Table not found
200 | 1254042 | ViewIdNotFound | View not found
200 | 1254043 | RecordIdNotFound | RecordIdNotFound
200 | 1254044 | FieldIdNotFound | FieldIdNotFound
200 | 1254045 | FieldNameNotFound | Field name does not exist
200 | 1254060 | TextFieldConvFail | TextFieldConvFail
200 | 1254061 | NumberFieldConvFail | NumberFieldConvFail
200 | 1254062 | SingleSelectFieldConvFail | SingleSelectFieldConvFail
200 | 1254063 | MultiSelectFieldConvFail | MultiSelectFieldConvFail
200 | 1254064 | DatetimeFieldConvFail | DatetimeFieldConvFail
200 | 1254065 | CheckboxFieldConvFail | CheckboxFieldConvFail
200 | 1254066 | UserFieldConvFail | The value corresponding to the personnel field type is incorrect. The possible reasons are:
- The ID type specified by the user_id_type parameter does not match the type of the provided ID.
- An unrecognized type or structure was provided. Currently, only `id` is supported, and it must be passed as an array.
- An `open_id` was passed across applications. If you are passing an ID across applications, it is recommended to use `user_id`. The `open_id` obtained from different applications cannot be used interchangeably.
200 | 1254067 | LinkFieldConvFail | LinkFieldConvFail
200 | 1254068 | URLFieldConvFail | URLFieldConvFail
200 | 1254069 | AttachFieldConvFail | AttachFieldConvFail
200 | 1254072 | InvalidPhoneNumber | Failed to convert phone field, please make sure it is correct.
400 | 1254074 | InvalidDuplexLinkField | The parameters of Duplex Link field are invalid and need to be filled with an array of string.
200 | 1254100 | TableExceedLimit | TableExceedLimit, limited to 300
200 | 1254101 | ViewExceedLimit | ViewExceedLimit, limited to 200
200 | 1254102 | FileExceedLimit | FileExceedLimit
200 | 1254103 | RecordExceedLimit | RecordExceedLimit, limited to 20,000
200 | 1254104 | RecordAddOnceExceedLimit | RecordAddOnceExceedLimit, limited to 500
200 | 1254105 | ColumnExceedLimit | ColumnExceedLimit
200 | 1254106 | AttachExceedLimit | AttachExceedLimit
200 | 1254112 | TooManyRequestInSingleBase | /
200 | 1254130 | TooLargeCell | TooLargeCell
200 | 1254290 | TooManyRequest | Request too fast, try again later
200 | 1254291 | Write conflict | The same data table does not support concurrent calls to the write interface, please check whether there is a concurrent call to the write interface. The writing interface includes: adding, modifying, and deleting records; adding, modifying, and deleting fields; modifying forms; modifying views, etc.
200 | 1254301 | OperationTypeError | Base does not have advanced permissions enabled or does not support enabling advanced permissions
200 | 1254303 | AttachmentNoPermission | The attachment does not belong to this base.
200 | 1255001 | InternalError | Internal error, have any questions can be consulting service
200 | 1255002 | RpcError | Internal error, have any questions can be consulting service
200 | 1255003 | MarshalError | Serialization failed, have any questions can be consulting service
200 | 1255004 | UmMarshalError | Deserialization failed, have any questions can be consulting service
200 | 1255005 | ConvError | Internal error, have any questions can be consulting service
504 | 1255040 | Request timed out, please try again later | Try again
400 | 1254607 | Data not ready, please try again later | There are usually two situations when this error occurs: 1. The last submitted modification has not been processed; 2. The data is too large and the server calculation times out;
This error code can be appropriately retried.
403 | 1254302 | Permission denied. | No access rights, usually caused by the table opening of advanced permissions, please add a group containing applications in the advanced permissions settings and give this group read and write permissions
403 | 1254304 | Permission denied. | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
403 | 1254608 | ReqRecommited | Same API requests are submitted repeatedly.