Create user field - Returning.AI

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

Body Params application/json

name

string

required

The name of the user field

>= 1 characters

Example:

User Level

type

enum<string>

required

The type of the user field

Allowed values:

textnumberbooleandateselect

Example:

number

description

string

optional

Optional description of the user field

Example:

The level of the user in the community

required

boolean

optional

Whether the field is required

Default:

false

Example:

false

defaultValue

optional

Default value for the field

Example:

1

options

array[string]

optional

Available options for select type fields

Example:

["Beginner","Intermediate","Advanced"]

Example

{
    "name": "User Level",
    "type": "number",
    "description": "The level of the user in the community",
    "required": false,
    "defaultValue": 1
}

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' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "User Level",
    "type": "number",
    "description": "The level of the user in the community",
    "required": false,
    "defaultValue": 1
}'

Responses

🟢201Created

application/json

Create user field successful

Body

meta

object

optional

status

string

optional

statusCode

number

optional

message

string

optional

Success message for the operation

data

object

optional

_id

string

optional

The unique identifier of the user field

name

string

optional

The name of the user field

type

enum<string>

optional

The type of the user field

Allowed values:

textnumberbooleandateselect

creator

object

optional

communityId

string

optional

The ID of the community this field belongs to

createdAt

string <date-time>

optional

When the field was created

updatedAt

string <date-time>

optional

When the field was last updated

Example

{
    "meta": {
        "status": "success",
        "statusCode": 201
    },
    "message": "Create user field successful",
    "data": {
        "_id": "6857de260f3c24d98fd7ca85",
        "name": "Total Points",
        "type": "number",
        "creator": {
            "_id": "61100af5c548eb5c7ebc7819",
            "id": 123456789,
            "avatar": "https://returning-ai.com/avatar.png",
            "displayName": "Admin",
            "username": "admin"
        },
        "communityId": "6167dba9c548eb5c7ec28057",
        "createdAt": "2025-06-22T11:28:50.301Z",
        "updatedAt": "2025-06-22T11:28:50.301Z"
    }
}

🟠400Bad Request

🟠404Record Not Found

🔴500Server Error