Delete user field

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

communityId

string

required

The ID of the community

fieldIdOrName

string

required

The ID or name of the user field to delete

Responses

🟢200OK

application/json

Delete user field successful

Body

meta

object

optional

status

string

optional

statusCode

number

optional

message

string

optional

Success message for the operation

data

object

optional

_id

string

optional

The unique identifier of the deleted user field

name

string

optional

The name of the deleted user field

field

string

optional

The field key of the deleted user field

type

string

optional

The type of the deleted user field

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

Request

Request samples

Responses