Update Custom User Field
PUT
/apis/v1/communities/{communityId}/user-fields/{fieldIdOrName}
Authorization
Permission:
User FieldsCommunity ID
Community ID is needed in the path.Appearance.Field ID or name
1.
Use the Get All User Fields endpoint to retrive all fields, use the
_id or field in the response.2.
In the community settings > User Fields, the
Field name and Field ID can be found in each field column.Update
name: the display name of the fieldtype: the type of the field. List of available types:Request
Path Params
Body Params application/json
Responses
Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location --request PUT '/apis/v1/communities//user-fields/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "Department",
"type": "numerical"
}'Response Response Example
200 - Success
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Updated user field",
"data": {
"_id": "6857de260f3c24d98fd7ca85",
"field": "department",
"name": "Department",
"type": "numerical",
"creator": {
"_id": "61100af5c548eb5c7ebc7819",
"avatar": "https://returning-ai.com/avatar.png",
"displayName": "Admin",
"username": "admin"
},
"createdAt": "2025-06-22T11:28:50.301Z",
"updatedAt": "2025-06-22T11:30:15.456Z"
}
}Modified at 2026-03-24 09:39:51