Recomms AI

Update a user

PATCH

https://api.recomms.ai/{database}/users/{id}

Users

Update an existing user's properties in the specified database.

Request

Path Params

database

string

required

The ID of the database to operate on

string

required

ID of the user to update

Body Params application/json

Object containing the properties to update. Additional properties can be included based on defined side info.

cascadeCreateSideInfo

boolean

optional

If true, automatically creates side info fields for properties that don't exist yet

Additional properties

integer | number | string | boolean

optional

Example

Example of updating a user's name, age, and preferences, with automatic side info creation

{
  "name": "John Smith",
  "age": 35,
  "preferences": [
    "books",
    "movies"
  ],
  "cascadeCreateSideInfo": true
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://api.recomms.ai//users/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "John Smith",
    "age": 35,
    "preferences": [
        "books",
        "movies"
    ],
    "cascadeCreateSideInfo": true
}'

Responses

🟢200OK

application/json

Successful operation

Body

status

enum<string>

optional

Allowed value:

success

message

string

optional

Example:

Resource updated successfully

Example

{
  "status": "success",
  "message": "Resource updated successfully"
}

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-03-16 13:43:21

Create a user

Get users