Skip to main content
PUT
Update parameter value
To change individual fields, use a partial update: PATCH changes only the fields you send. A parameter definition can be used only once per product. The format of Value depends on the definition type: Once created, ParameterDefinitionId cannot be changed (2211); only Value can be updated. To use a different definition, delete this record and create a new one.

Authorizations

Authorization
string
header
required

Access token obtained from the Noyax auth service with your API key.

Headers

X-UserID
integer<int32>
required

ID of the Noyax user the request is made on behalf of. Written to the audit fields of created, updated and deleted records.

Required range: x >= 1
X-CompanyID
integer<int32>
required

ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.

Required range: x >= 1
X-PeriodID
integer<int32>

ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.

Required range: x >= 1

Path Parameters

productId
string<uuid>
required

Product ID.

parameterId
string<uuid>
required

Parameter value ID.

Body

ParameterDefinitionId
null | string<uuid>

Required. ID of a parameter definition from GET /api/v1/products/parameter-definitions.

Value
any

Required. Format depends on the definition type. 0: Text, 1: true/false, 2: Integer, 3: Decimal (dot as separator), 4: Date, 5: Time, 6: Date and time (ISO 8601, e.g. "2026-09-17T14:30:00").

Example:

"Galvaniz"

Response

OK

Success
boolean
required

Whether the operation succeeded.

Example:

true

ResultCode
string
required

"0000" on success. On failure, the code of the first error; all errors are listed in Errors.

Example:

"0000"

Data
object
required
Message
null | string

Error message when Success is false. Messages of all errors are joined into a single text.