Update Custom User Field

PUT

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

Update an existing custom definition. The stable field key is immutable. Explicit defaultValue: null clears the default.

Request

Path Params

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

User field updated successfully

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

renameclearDefault

curl --location --request PUT 'https://sgtr-api.returning.ai/v1/communities//user-fields/' \
--header 'Authorization;' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Lifetime Trading Volume"
}'

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-07-20 19:32:20

Get Specific User Field

Delete Custom User Field