Update Custom User Field

This endpoint updates an existing custom user field in a community.

Authorization

Bearer token Required

Found in the platform under community settings > API keys.
Permission: User Fields

Community ID

Community ID is needed in the path.

Found in the platform under community settings > Appearance.

Field ID or name

The unique identifier (ObjectId) or name (string) of the custom user field to update. There are 2 methods to get the field ID or name

Via API
Use the Get All User Fields endpoint to retrive all fields, use the _id or field in the response.

Via community settings
In the community settings > User Fields, the Field name and Field ID can be found in each field column.

Update

Only the field's display name and type can be updated.

name: the display name of the field

type: the type of the field. List of available types:

single-line-text

multi-line-text

numerical

date

time

date-time

boolean

single-select-dropdown

multi-select-dropdown

Changing a custom field's data type after it has been populated with data may cause system errors and potential data loss. Always create a new field instead of modifying the type of an existing field that is in use.

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": "numerical"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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": "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"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Update Custom User Field

Authorization#

Community ID#

Field ID or name#

Update#

Request

Request Code Samples

Responses

Authorization

Community ID

Field ID or name

Update