Delete user field

DELETE

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

Deletes an existing user field from a community.

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Delete user field successful

Body

Example

{
    "meta": {
        "status": "success",
        "statusCode": 200
    },
    "message": "Delete user field successful",
    "data": {
        "_id": "6857de260f3c24d98fd7ca85",
        "name": "Total Points",
        "field": "total_points",
        "type": "number"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

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

Update user field

Get all user field histories in a community