Create link
curl --request POST \
--url https://api.noyax.com/api/v1/customers/{customerId}/links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Value": "[email protected]"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/links");
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 \"Value\": \"[email protected]\"\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({Value: '[email protected]'})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/links', 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}/links"
payload = { "Value": "[email protected]" }
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",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Value": "[email protected]",
"LinkType": 1,
"Description": "Invoices"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1303",
"Message": "Value of an email link must be a valid email address.",
"Errors": [
{
"Code": "1303",
"Message": "Value of an email link must be 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": "1000",
"Message": "Customer not found.",
"Errors": [
{
"Code": "1000",
"Message": "Customer not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Links
Create link
Adds a new link to a customer.
POST
/
api
/
v1
/
customers
/
{customerId}
/
links
Create link
curl --request POST \
--url https://api.noyax.com/api/v1/customers/{customerId}/links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-CompanyID: <x-companyid>' \
--header 'X-UserID: <x-userid>' \
--data '
{
"Value": "[email protected]"
}
'using RestSharp;
var options = new RestClientOptions("https://api.noyax.com/api/v1/customers/{customerId}/links");
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 \"Value\": \"[email protected]\"\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({Value: '[email protected]'})
};
fetch('https://api.noyax.com/api/v1/customers/{customerId}/links', 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}/links"
payload = { "Value": "[email protected]" }
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",
"CustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"Value": "[email protected]",
"LinkType": 1,
"Description": "Invoices"
},
"Message": "<string>"
}{
"Success": false,
"ResultCode": "1303",
"Message": "Value of an email link must be a valid email address.",
"Errors": [
{
"Code": "1303",
"Message": "Value of an email link must be 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": "1000",
"Message": "Customer not found.",
"Errors": [
{
"Code": "1000",
"Message": "Customer not found."
}
]
}{
"Success": false,
"ResultCode": "0120",
"Message": "Daily request limit (10000) exceeded.",
"Errors": [
{
"Code": "0120",
"Message": "Daily request limit (10000) exceeded."
}
]
}Value is required. LinkType: 0 other, 1 e-mail, 2 website, 3 LinkedIn, 4 Instagram, 5 X. For type 1 the value must be a valid e-mail address.
Error codes
Codes this endpoint can return. The general errors that apply to every endpoint (authentication, permissions, request headers, request limits) are not repeated here.| Code | HTTP | Meaning |
|---|---|---|
0002 | 400 | Request body could not be read (malformed JSON, wrong field type), or it contains a field the endpoint does not have |
1000 | 404 | Customer not found or not visible to the user. Also returned by sub-record endpoints |
1301 | 400 | Value is required |
1302 | 400 | LinkType must be between 0 and 5 |
1303 | 400 | The value of an e-mail link is not a valid e-mail address |
Authorizations
Headers
Body
application/jsontext/jsonapplication/*+json
Required. E-mail address or URL. Must be a valid e-mail address when LinkType is 1.
Example:
Response
Created