Update product parameter definition
curl --request PUT \
--url https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "Malzeme",
"Type": 0
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Name\": \"Malzeme\",\n \"Type\": 0\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PUT',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Name: 'Malzeme', Type: 0})
};
fetch('https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId}"
payload = {
"Name": "Malzeme",
"Type": 0
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "Malzeme",
"Type": 0
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "2502",
"Message": "Parameter definition name 'Malzeme' is already used in this company.",
"Errors": [
{
"Code": "2502",
"Message": "Parameter definition name 'Malzeme' is already used in this company."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "2500",
"Message": "Parameter definition not found.",
"Errors": [
{
"Code": "2500",
"Message": "Parameter definition not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Parameter definitions
Update product parameter definition
Replaces all fields of the definition.
PUT
/
api
/
v1
/
products
/
parameter-definitions
/
{parameterDefinitionId}
Update product parameter definition
curl --request PUT \
--url https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "Malzeme",
"Type": 0
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId}");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("X-UserID", "<x-userid>");
request.AddHeader("X-CompanyID", "<x-companyid>");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n \"Name\": \"Malzeme\",\n \"Type\": 0\n}", false);
var response = await client.PutAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PUT',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Name: 'Malzeme', Type: 0})
};
fetch('https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/products/parameter-definitions/{parameterDefinitionId}"
payload = {
"Name": "Malzeme",
"Type": 0
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "Malzeme",
"Type": 0
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "2502",
"Message": "Parameter definition name 'Malzeme' is already used in this company.",
"Errors": [
{
"Code": "2502",
"Message": "Parameter definition name 'Malzeme' is already used in this company."
}
]
}{
"Success": false,
"ResultCode": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token.",
"Errors": [
{
"Code": "0102",
"Message": "Token has expired. Obtain a new token using the refresh token."
}
]
}{
"Success": false,
"ResultCode": "0110",
"Message": "You do not have permission for this operation.",
"Errors": [
{
"Code": "0110",
"Message": "You do not have permission for this operation."
}
]
}{
"Success": false,
"ResultCode": "2500",
"Message": "Parameter definition not found.",
"Errors": [
{
"Code": "2500",
"Message": "Parameter definition not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}To change individual fields, use a partial update:
PATCH changes only the fields you send.
Name is required and must be unique within the company. Type decides the format of the Value field in product parameters, and can still be changed after creation:
| Type | Meaning | Example Value |
|---|---|---|
0 | Text | "Galvaniz" |
1 | Yes/No | true |
2 | Integer | 12 |
3 | Decimal | 12.5 |
4 | Date | "2026-09-17" |
5 | Time | "14:30" |
6 | Date and time | "2026-09-17T14:30:00" |
Authorizations
Access token obtained from the Noyax auth service with your API key.
Headers
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 >= 1ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.
Required range:
x >= 1ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.
Required range:
x >= 1Path Parameters
Parameter definition ID.
Body
application/jsontext/jsonapplication/*+json
Response
OK
Whether the operation succeeded.
Example:
true
"0000" on success. On failure, the code of the first error; all errors are listed in Errors.
Example:
"0000"
Show child attributes
Show child attributes
Error message when Success is false. Messages of all errors are joined into a single text.