Create customer parameter definition
curl --request POST \
--url https://api.noyax.com/api/v1/customers/parameter-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "Segment",
"Type": 0
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/parameter-definitions");
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\": \"Segment\",\n \"Type\": 0\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Name: 'Segment', Type: 0})
};
fetch('https://api.noyax.com/api/v1/customers/parameter-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/parameter-definitions"
payload = {
"Name": "Segment",
"Type": 0
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "Segment",
"Type": 0
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1901",
"Message": "Parameter definition Name is required.",
"Errors": [
{
"Code": "1901",
"Message": "Parameter definition Name is required."
}
]
}{
"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": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Parameter definitions
Create customer parameter definition
Adds a new customer parameter definition.
POST
/
api
/
v1
/
customers
/
parameter-definitions
Create customer parameter definition
curl --request POST \
--url https://api.noyax.com/api/v1/customers/parameter-definitions \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Name": "Segment",
"Type": 0
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/parameter-definitions");
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\": \"Segment\",\n \"Type\": 0\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'POST',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({Name: 'Segment', Type: 0})
};
fetch('https://api.noyax.com/api/v1/customers/parameter-definitions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.noyax.com/api/v1/customers/parameter-definitions"
payload = {
"Name": "Segment",
"Type": 0
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Name": "Segment",
"Type": 0
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1901",
"Message": "Parameter definition Name is required.",
"Errors": [
{
"Code": "1901",
"Message": "Parameter definition Name is required."
}
]
}{
"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": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Name is required and must be unique within the company. Type decides the format of the Value field in customer parameters, and can still be changed after creation:
| Type | Meaning | Example Value |
|---|---|---|
0 | Text | "Öncelikli" |
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 >= 1Body
application/jsontext/jsonapplication/*+json
Response
Created
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.