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
Provide your bearer token in the Authorization
header when making requests to protected resources. Example:Authorization: Bearer ********************
Request Code Samples
curl --location --request DELETE 'https://application.returning.ai/apis/v1/communities//user-fields/' \
--header 'Authorization: Bearer <token>'
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 2025-09-24 03:04:49
