PUT /custom-data/
Upsert Custom Data
PUT
/custom-data/{key}
Create or replace a custom-data entry.
Validates key format (lowercase alphanumeric + underscore, max 64 chars),
then inserts or replaces the CustomData document. Existing documents are
fully replaced (check_rev=False). Returns a message indicating whether
the entry was created or updated.
Emits: (direct transaction — no event class)
Required scope: admin:custom-data:write
Authorizations
OAuth2PasswordBearer
password Flow
Token URL
"/api/auth"Scopes:
"admin"User can access and edit users and system settings"library"User can access and edit products"production"User can access and edit production plans"operator"User can access the operator panel and make production declarations
Parameters
Path Parameters
key*
Type
Requiredstring
Request Body
application/json
JSON "_id": "string", "_key": "string", "_rev": "string", "value": "https://erp.example.com/api/v2", "description": "Base URL of the ERP integration endpoint, used by the sync workflow."
{
}
Responses
Successful Response
application/json
JSON "status": 200, "message": "string", "detail": "string"
{
}