Update user field - Returning.AI

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

communityId

string

required

The unique identifier of the community

Example:

6167dba9c548eb5c7ec28057

Match pattern:

^[0-9a-fA-F]{24}$

fieldIdOrName

string

required

The unique identifier (ObjectId) or name (string) of the user field to update

Example:

6857de260f3c24d98fd7ca85

Body Params application/json

name

string

required

Display name of the field

type

enum<string>

required

Data type of the user field

Allowed values:

datesingle-line-textnumericalmulti-line-textnumbertext

Examples

Update text fieldUpdate numerical field

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

User field updated successfully

Body

meta

object

optional

status

string

optional

statusCode

number

optional

message

string

optional

Success message for the operation

data

object

optional

_id

string

optional

Unique identifier for the user field

field

string

optional

Field identifier/key (automatically generated and cannot be changed)

name

string

optional

Display name of the field

type

enum<string>

optional

Data type of the user field

Allowed values:

datesingle-line-textnumericalmulti-line-textnumbertext

creator

object | null

optional

Information about the user who created the field

createdAt

string <date-time>

optional

When the field was created

updatedAt

string <date-time>

optional

When the field was last updated

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