Add a supplier contact
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts"
payload = {
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_name: '<string>',
contact_email: 'jsmith@example.com',
contact_phone: '<string>'
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contact_name' => '<string>',
'contact_email' => 'jsmith@example.com',
'contact_phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts"
payload := strings.NewReader("{\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contact_details_id": 123,
"supplier_id": 123,
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"error": "Not Found",
"message": "The requested resource could not be found",
"status_code": 404
}{
"message": "<string>",
"errors": {}
}Suppliers
Add a supplier contact
Attach a new contact to a supplier. This appends to the supplier’s existing contacts rather than replacing them. The contact email must be unique across the platform.
POST
/
suppliers
/
{supplierId}
/
contacts
Add a supplier contact
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts"
payload = {
"contact_name": "<string>",
"contact_email": "jsmith@example.com",
"contact_phone": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
contact_name: '<string>',
contact_email: 'jsmith@example.com',
contact_phone: '<string>'
})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'contact_name' => '<string>',
'contact_email' => 'jsmith@example.com',
'contact_phone' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts"
payload := strings.NewReader("{\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/suppliers/{supplierId}/contacts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"contact_name\": \"<string>\",\n \"contact_email\": \"jsmith@example.com\",\n \"contact_phone\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"contact_details_id": 123,
"supplier_id": 123,
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}{
"error": "Unauthorized",
"message": "Authentication credentials are missing or invalid",
"status_code": 401
}{
"error": "Not Found",
"message": "The requested resource could not be found",
"status_code": 404
}{
"message": "<string>",
"errors": {}
}Authorizations
Authenticate using a bearer token. To create a token, navigate to /settings/api-tokens and click Create API Token.
Path Parameters
The unique identifier of the supplier.
Body
application/json
Contact name.
Maximum string length:
255Contact email address. Must be unique across all contacts on the platform; reusing an existing email returns a 422 validation error.
Maximum string length:
255Contact phone number.
Maximum string length:
255Response
Contact successfully attached to the supplier
A contact attached to a supplier.
Show child attributes
Show child attributes