Create or update an inventory item

POST

/api/v1/apps/{appId}/inventory

Creates or updates an inventory item for a specific user within an application. Requires Admin/Owner role or API Key with 'inventory:write' permission. Supports setting both user and system metadata. If an item with the same userId and itemName exists, it updates; otherwise, it creates.

Request

Path Params

Body Params application/json

Examples

Responses

🟢200OK

application/json

Inventory item updated successfully

Body

🟢201Created

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://useraccounts.srblabs.io/api/v1/apps//inventory' \
--header 'Content-Type: application/json' \
--data-raw '{
    "itemName": "Sword of Power",
    "itemType": "weapon",
    "systemMetadata": {},
    "userId": "a4e1e3d6-8e1b-4f5a-9e2d-7f1c8a1b9d0e",
    "userMetadata": {}
}'

Response Example

200 - Example 1

{
    "applicationId": "string",
    "createdAt": "string",
    "id": "string",
    "itemName": "string",
    "itemType": "string",
    "latestSystemMetadataVersion": 0,
    "latestUserMetadataVersion": 0,
    "retrievedMetadata": {
        "createdAt": "string",
        "data": {},
        "type": "string",
        "version": 0
    },
    "systemMetadata": {},
    "updatedAt": "string",
    "userId": "string",
    "userMetadata": {}
}

Modified at 2025-05-03 01:39:15

List inventory items for an application

database.CustomSystemDataRecord