# Update role
Update a role
**Notice**：The update of the role is an incremental update, where only the passed fields are updated, and the fields that are not passed are not updated
## Prerequisite
To call the custom role-related APIs, you need to ensure that Base has enabled advanced permissions. You can enable advanced permissions through the [Update Base Metadata](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/reference/bitable-v1/app/update) API.
## Request
Facts |
---|---
HTTP URL | https://open.feishu.cn/open-apis/bitable/v1/apps/:app_token/roles/:role_id
HTTP Method | PUT
Rate Limit | [10 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:role:update)
View, comment, edit and manage Base(bitable: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"
role_id | string | Role id
**Example value**: "roljRpwIUt"
### Request body
Parameter | Type | Required | Description
---|---|---|---
role_name | string | Yes | Role name
**Example value**: "role1"
table_roles | app.role.table_role\[\] | Yes | Table role
**Data validation rules**:
- Maximum length: `100`
table_perm | int | Yes | Table perm
**Example value**: 0
**Optional values are**:
- 0：No permissions
- 1：View only
- 2：Can edit records
- 4：Can edit records and fields
**Default value**: `0`
table_name | string | No | Table name
**Example value**: "table1"
table_id | string | No | Table id
**Example value**: "tblKz5D60T4JlfcT"
rec_rule | app.role.table_role.rec_rule | No | Record filter rule
conditions | app.role.table_role.rec_rule.condition\[\] | Yes | Coditions
**Data validation rules**:
- Maximum length: `100`
field_name | string | Yes | Field name
**Example value**: "Single option"
operator | string | No | Operator
**Example value**: "is"
**Optional values are**:
- is：Is
- isNot：Is not
- contains：Contains
- doesNotContain：Does not contain
- isEmpty：Is empty
- isNotEmpty：Is not empty
**Default value**: `is`
value | string\[\] | No | Option id
**Example value**: ["optbdVHf4q"]
conjunction | string | No | Conjunction
**Example value**: "and"
**Optional values are**:
- and：And
- or：Or
**Default value**: `and`
other_perm | int | No | Other perm
**Example value**: 0
**Optional values are**:
- 0：Cannot view
- 1：View Only
**Default value**: `0`
field_perm | map<string, int> | No | Permission of fields, only valid when `table_perm` is 2. The type is map, key is field name, value is permission of field.
**Optional values are**:
- `1`: View only
- `2`: Can edit records
**Example value**: {"姓名": 1, "年龄": 2}
allow_add_record | boolean | No | Added record permission, only meaningful when the table_perm is 2, used to set whether the record can be added
**Example value**: true
**Default value**: `true`
allow_delete_record | boolean | No | Delete record permission, meaningful only when the table_perm is 2, used to set whether the record can be deleted
**Example value**: true
**Default value**: `true`
block_roles | app.role.block_role\[\] | No | Block role
**Data validation rules**:
- Maximum length: `100`
block_id | string | Yes | Block id, Such as dashboard block id in list dashboards method
**Example value**: "blknkqrP3RqUkcAW"
block_perm | int | Yes | Block perm
**Example value**: 0
**Optional values are**:
- 0：No permissions
- 1：View only
**Default value**: `0`
### Request body example
```json
{
"role_name": "role1",
"table_roles": [
{
"table_perm": 0,
"table_name": "table1",
"table_id": "tblKz5D60T4JlfcT",
"rec_rule": {
"conditions": [
{
"field_name": "Single option",
"operator": "is",
"value": [
"optbdVHf4q"
]
}
],
"conjunction": "and",
"other_perm": 0
},
"field_perm": {
"姓名": 1,
"年龄": 2
},
"allow_add_record": true,
"allow_delete_record": true
}
],
"block_roles": [
{
"block_id": "blknkqrP3RqUkcAW",
"block_perm": 0
}
]
}
```
## Response
### Response body
Parameter | Type | Description
---|---|---
code | int | Error codes, fail if not zero
msg | string | Error descriptions
data | \- | \-
role | app.role | Role information
role_name | string | Role name
role_id | string | Role id
table_roles | app.role.table_role\[\] | Table role
table_perm | int | Table perm
**Optional values are**:
- 0：No permissions
- 1：View only
- 2：Can edit records
- 4：Can edit records and fields
table_name | string | Table name
table_id | string | Table id
rec_rule | app.role.table_role.rec_rule | Record filter rule
conditions | app.role.table_role.rec_rule.condition\[\] | Coditions
field_name | string | Field name
operator | string | Operator
**Optional values are**:
- is：Is
- isNot：Is not
- contains：Contains
- doesNotContain：Does not contain
- isEmpty：Is empty
- isNotEmpty：Is not empty
value | string\[\] | Option id
field_type | int | Field type
conjunction | string | Conjunction
**Optional values are**:
- and：And
- or：Or
other_perm | int | Other perm
**Optional values are**:
- 0：Cannot view
- 1：View Only
field_perm | map<string, int> | Permission of fields, only valid when `table_perm` is 2. The type is map, key is field name, value is permission of field.
**Optional values are**:
- `1`: View only
- `2`: Can edit records
allow_add_record | boolean | Added record permission, only meaningful when the table_perm is 2, used to set whether the record can be added
allow_delete_record | boolean | Delete record permission, meaningful only when the table_perm is 2, used to set whether the record can be deleted
block_roles | app.role.block_role\[\] | Block role
block_id | string | Block id, Such as dashboard block id in list dashboards method
block_type | string | Block type
**Optional values are**:
- dashboard：Dashboard
block_perm | int | Block perm
**Optional values are**:
- 0：No permissions
- 1：View only
### Response body example
```json
{
"data": {
"role": {
"role_id": "rolgFH5DO4",
"role_name": "role1",
"table_roles": [
{
"table_name": "table1",
"table_id": "tblFIgBzKEq75HSE",
"table_perm": 2,
"addrecords_perm": false,
"deleterecords_perm": true,
"rec_rule": {
"conjunction": "or",
"conditions": [
{
"field_name": "Single option",
"operator": "is",
"field_type": 3,
"value": [
"optbdVHf4q"
]
},
{
"value": null,
"field_name": "Perspm",
"operator": "contains",
"field_type": 11
},
{
"operator": "contains",
"field_type": 1003,
"value": null,
"field_name": ""
}
],
"other_perm": 0
},
"field_perm": {
"Single option": 1,
"Age": 2
}
},
{
"table_name": "table2",
"table_id": "tblMPI6OC1aWvTvs",
"table_perm": 1,
"rec_rule": {
"conditions": [
{
"field_name": "Person",
"operator": "contains",
"field_type": 11,
"value": null
},
{
"operator": "is",
"field_type": 4,
"value": [
"opttgKOTSt",
"optWcdXR0W"
],
"field_name": "Multiple options"
}
],
"other_perm": 0,
"conjunction": "and"
}
},
{
"table_name": "table3",
"table_id": "tblmkLF7Tg6IWbRb",
"table_perm": 0
},
{
"table_name": "table4",
"table_id": "tbl5VQHDTms19Qe7",
"table_perm": 4
}
],
"block_roles": [
{
"block_id": "blknkqrP3RqUkcAW",
"block_perm": 0
},
{
"block_id": "blkAjxjWKvbBi7EA",
"block_perm": 1
}
],
"role_id": "rolgFH5DO4"
}
},
"code": 0,
"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 | 1254010 | ReqConvError | Request error
400 | 1254032 | InvalidRoleName | Invalid role name
400 | 1254033 | RoleNameDuplicated | Role name duplicated
400 | 1254036 | Base is copying, please try again later. | Base copy replicating, try again later
200 | 1254040 | BaseTokenNotFound | AppToken not found
404 | 1254047 | RoleIdNotFound | Role not found
400 | 1254110 | RoleExceedLimit | Role exceed limit, limited to 30
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.
400 | 1254301 | OperationTypeError | Base does not have advanced permissions enabled or does not support enabling advanced permissions
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 | Only Available For Business and Enterprise Editions | Advanced permissions for specific rows or columns are only available for Business and Enterprise editions
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
504 | 1255040 | Request timed out, please try again later | Try again