Delete Custom User Field

DELETE

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

Delete one custom field definition. Confirm dependent integrations before deletion; the stable key may still appear in legacy history rows.

Request

Path Params

Header Params

Responses

🟢200OK

application/json

Delete user field successful

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request DELETE 'https://sgtr-api.returning.ai/v1/communities//user-fields/' \
--header 'Authorization;'

Response Example

200 - Success

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

Modified at 2026-07-20 19:32:20

Update Custom User Field

Get all user fields for a community