Skip to main content
PATCH
Partially update product group detail
Send only the fields you want to change; fields you do not send keep their current values. Rules and examples: partial update.
  • Send "ParentGroupDetailId": null to remove the parent; the detail then becomes selectable under every parent.
  • ParentGroupDetailId cannot be changed while other details use this detail as their parent (2109).

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

groupDetailId
string<uuid>
required

Product group detail ID.

Body

GroupNumber
integer<int32>

Required. Which product group the detail belongs to: 1-5, matching GroupDetailId1...GroupDetailId5 of a product.

Example:

2

Name
null | string

Required. Detail name, unique within the group. At most 50 characters.

Example:

"SEDAN"

ParentGroupDetailId
null | string<uuid>

ID of the parent detail, which must belong to the previous group (GroupNumber - 1). Leave it empty to make the detail selectable under every parent. Group 1 details cannot have a parent.

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.