This endpoint deletes an custom user field in a community.Authorization#
Found in the platform under community settings > API keys.
Permission: User FieldsCommunity 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 name1.
Via API
Use the Get All User Fields endpoint to retrive all fields, use the _id or field in the response. 2.
Via community settings
In the community settings > User Fields, the Field name and Field ID can be found in each field column.
Request Code Samples
curl --location --request DELETE 'https://sgtr-rai-api.returning.ai/api/v1/apis/v1/communities//user-fields/'
Responses
application/json
Delete user field successful
{
"meta": {
"status": "success",
"statusCode": 200
},
"message": "Delete user field successful",
"data": {
"_id": "6857de260f3c24d98fd7ca85",
"name": "Total Points",
"field": "total_points",
"type": "number"
}
}
Modified at 2026-04-09 08:33:01
