Create user field

POST

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

Creates a new user field for a community

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Create user field successful

Bodyapplication/json

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.returning.ai/v1/communities//user-fields' \
--header 'Content-Type: application/json' \
--data '{
    "name": "User Level",
    "type": "number",
    "description": "The level of the user in the community",
    "required": false,
    "defaultValue": 1
}'

Response Example

201 - Success

{
    "meta": {
        "status": "success",
        "statusCode": 201
    },
    "message": "Create user field successful",
    "data": {
        "_id": "6857de260f3c24d98fd7ca85",
        "name": "Total Points",
        "type": "number",
        "creator": {
            "_id": "61100af5c548eb5c7ebc7819",
            "id": 123456789,
            "avatar": "https://returning-ai.com/avatar.png",
            "displayName": "Admin",
            "username": "admin"
        },
        "communityId": "6167dba9c548eb5c7ec28057",
        "createdAt": "2025-06-22T11:28:50.301Z",
        "updatedAt": "2025-06-22T11:28:50.301Z"
    }
}

Modified at 2026-05-18 17:08:22

Update Custom User Field

Delete Custom User Field