Products API

Create or update a product

post

Creates or updates a product with the provided details

Authorizations
Body
idstringRequired

Unique identifier for the product

Example: product-id
typeIdstringRequired

Type identifier for the product

Example: type-id
propertiesUpdateTypestringOptional

The type of update. Valid values are either FULL_UPDATE or INCREMENTAL_UPDATE. When using full update mode, any pre-existing properties not included in the request will be removed. Defaults to INCREMENTAL_UPDATE.

Example: INCREMENTAL_UPDATE
Responses
204

Product created successfully (No Content)

No content

post
/product
POST /product HTTP/1.1
Host: integration-api.userflux.co
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "id": "product-id",
  "typeId": "type-id",
  "properties": {},
  "propertiesUpdateType": "INCREMENTAL_UPDATE",
  "aiPropertyOverrides": {
    "somePath": "some value which will override the value from the LLM generation"
  }
}

No content

Delete a product

delete

Deletes a product with the provided details

Authorizations
Path parameters
typeIdstringRequired

ID of the Product Type

productIdstringRequired

ID of the Product

delete
/product/{typeId}/{productId}
DELETE /product/{typeId}/{productId} HTTP/1.1
Host: integration-api.userflux.co
Accept: */*

Last updated