Create user field history

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 community ID

fieldId

string

required

The field ID

userId

string

required

The user ID

Body Params application/json

value

number

required

The value to apply to the field

Example:

10

action

enum<string>

optional

The action to perform on the field value

Allowed values:

increasedecreaseoverwrite

Default:

increase

Example:

increase

Example

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

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

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

Responses

🟢201Created

application/json

User field history created successfully

Body

meta

object

optional

status

string

optional

statusCode

number

optional

sum

number

optional

The calculated sum value after the operation

message

string

optional

Success message for the operation

data

object

optional

_id

string

optional

The user field history ID

fieldId

string

optional

The field ID

value

number

optional

The value of the field change

action

enum<string>

optional

The action performed on the field

Allowed values:

increasedecreaseoverwrite

createdAt

string <date-time>

optional

When the history entry was created

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