Skip to main content
PATCH
Partially update customer parameter definition
Send only the fields you want to change; fields you do not send keep their current values. Rules and examples: partial update.

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

parameterDefinitionId
string<uuid>
required

Parameter definition ID.

Body

Name
null | string

Required. Parameter name, unique within the company. At most 255 characters.

Example:

"Segment"

Type
integer<int32>

Required. Value type: 0 Text, 1 Yes/No, 2 Integer, 3 Decimal, 4 Date, 5 Time, 6 Date and time.

Example:

0

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.