Create user field history for specific user

POST

/apis/v1/communities/{communityId}/users/{userId}/user-fields/{fieldIdOrName}/histories

Creates a new history entry for a user field value change in 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

Body Params application/json

Example

{
    "value": 10,
    "action": "increase"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://application.returning.ai/apis/v1/communities//users//user-fields//histories' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "value": 10,
    "action": "increase"
}'

Responses

🟢201Created

application/json

User field history created successfully

Body

Example

{
    "meta": {
        "status": "success",
        "statusCode": 201,
        "sum": 500
    },
    "message": "User field history created successfully",
    "data": {
        "_id": "685957701ff244c62bd2e5b4",
        "fieldId": "6857de260f3c24d98fd7ca89",
        "value": 500,
        "action": "overwrite",
        "createdAt": "2025-06-23T13:32:32.950Z"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error

Modified at 2025-11-04 04:18:51

Get user field histories of specific user field and user

Integration API