Update user field

PUT

/apis/v1/communities/{communityId}/user-fields/{fieldIdOrName}

Updates an existing user field in a community with new values.

Security Requirements:

Bearer token authentication required

Only community owners and administrators can access this endpoint

User must have either COMMUNITY_OWNER or COMMUNITY_ADMIN permissions for the specified community

Community API key with userFields permission can also be used

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Examples

Update text fieldUpdate numerical field

{
    "name": "Department",
    "type": "text"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

cURL

Update text fieldUpdate numerical field

curl --location --request PUT 'https://application.returning.ai/apis/v1/communities/6167dba9c548eb5c7ec28057/user-fields/6857de260f3c24d98fd7ca85' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "Department",
    "type": "text"
}'

Responses

🟢200OK

application/json

User field updated successfully

Body

Example

{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Updated user field",
    "data": {
        "_id": "6857de260f3c24d98fd7ca85",
        "field": "department",
        "name": "Department",
        "type": "text",
        "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"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Modified at 2025-08-28 10:35:00

Create user field

Delete user field