curl --request PATCH \
--url https://api.noyax.com/api/v1/customers/{customerId}/representatives/{representativeId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/representatives/{representativeId}");
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 \"FullName\": \"Ayşe Yılmaz\",\n \"Position\": \"Purchasing Manager\",\n \"Gsm\": \"05325550000\",\n \"Email\": \"[email protected]\",\n \"Phone\": \"02165550000\",\n \"Extension\": \"105\",\n \"Link\": \"https://www.linkedin.com/in/example\",\n \"Description\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PATCH',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
FullName: 'Ayşe Yılmaz',
Position: 'Purchasing Manager',
Gsm: '05325550000',
Email: '[email protected]',
Phone: '02165550000',
Extension: '105',
Link: 'https://www.linkedin.com/in/example',
Description: '<string>'
})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/representatives/{representativeId}', 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/{customerId}/representatives/{representativeId}"
payload = {
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1402",
"Message": "Representative Email is not a valid email address.",
"Errors": [
{
"Code": "1402",
"Message": "Representative Email is not a valid email address."
}
]
}{
"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": "1400",
"Message": "Representative not found.",
"Errors": [
{
"Code": "1400",
"Message": "Representative not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Partially update representative
Changes only the sent fields of a representative.
curl --request PATCH \
--url https://api.noyax.com/api/v1/customers/{customerId}/representatives/{representativeId} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/representatives/{representativeId}");
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 \"FullName\": \"Ayşe Yılmaz\",\n \"Position\": \"Purchasing Manager\",\n \"Gsm\": \"05325550000\",\n \"Email\": \"[email protected]\",\n \"Phone\": \"02165550000\",\n \"Extension\": \"105\",\n \"Link\": \"https://www.linkedin.com/in/example\",\n \"Description\": \"<string>\"\n}", false);
var response = await client.PatchAsync(request);
Console.WriteLine("{0}", response.Content);
const options = {
method: 'PATCH',
headers: {
'X-UserID': '<x-userid>',
'X-CompanyID': '<x-companyid>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
FullName: 'Ayşe Yılmaz',
Position: 'Purchasing Manager',
Gsm: '05325550000',
Email: '[email protected]',
Phone: '02165550000',
Extension: '105',
Link: 'https://www.linkedin.com/in/example',
Description: '<string>'
})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/representatives/{representativeId}', 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/{customerId}/representatives/{representativeId}"
payload = {
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
}
headers = {
"X-UserID": "<x-userid>",
"X-CompanyID": "<x-companyid>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text){
"Success": true,
"ResultCode": "0000",
"Data": {
"Id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"FullName": "Ayşe Yılmaz",
"Position": "Purchasing Manager",
"Gsm": "05325550000",
"Email": "[email protected]",
"Phone": "02165550000",
"Extension": "105",
"Link": "https://www.linkedin.com/in/example",
"Description": "<string>"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1402",
"Message": "Representative Email is not a valid email address.",
"Errors": [
{
"Code": "1402",
"Message": "Representative Email is not a valid email address."
}
]
}{
"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": "1400",
"Message": "Representative not found.",
"Errors": [
{
"Code": "1400",
"Message": "Representative not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}- A field that is not sent stays unchanged, a field sent as
nullis cleared. - Validation runs on the whole merged record; setting a required field to
nullis rejected.
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.
x >= 1ID of the company. The user must be assigned to this company. All reads and writes are limited to this company.
x >= 1ID of the accounting period. Optional for customer endpoints; if sent, it is written to created records.
x >= 1Path Parameters
Customer ID.
Representative ID.
Body
Required. Full name of the contact person.
"Ayşe Yılmaz"
Job title or position.
"Purchasing Manager"
Mobile phone number.
"05325550000"
E-mail address. Must be valid if sent.
Landline phone number.
"02165550000"
Extension number.
"105"
Link, e.g. a LinkedIn profile.
"https://www.linkedin.com/in/example"
Description.
Response
OK
Whether the operation succeeded.
true
"0000" on success. On failure, the code of the first error; all errors are listed in Errors.
"0000"
Show child attributes
Show child attributes
Error message when Success is false. Messages of all errors are joined into a single text.