Set or rotate B2B portal password
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"password": "minimum8chars"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password"
payload = { "password": "minimum8chars" }
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({password: 'minimum8chars'})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password', 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/contacts/{contactId}/b2b-portal-password",
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([
'password' => 'minimum8chars'
]),
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/contacts/{contactId}/b2b-portal-password"
payload := strings.NewReader("{\n \"password\": \"minimum8chars\"\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/contacts/{contactId}/b2b-portal-password")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"password\": \"minimum8chars\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password")
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 \"password\": \"minimum8chars\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "789123",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@acmecorp.com",
"phone": "555-987-6543",
"phone_2": "555-555-5555",
"full_name": "John Smith",
"company_id": "123456",
"company": {
"id": "123456",
"name": "Acme Corporation"
},
"is_primary": true,
"receive_quotation_pdf": false,
"receive_purchase_order_pdf": false,
"receive_purchase_order_invoice_pdf": false,
"has_portal_login": false,
"companies": [
{
"id": 123,
"name": "<string>",
"is_primary": true,
"receive_quotation_pdf": true,
"receive_purchase_order_pdf": true,
"receive_purchase_order_invoice_pdf": true
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>",
"errors": {}
}Contacts
Set or rotate B2B portal password
Sets or rotates the B2B client portal password for a contact. Uses the same backend logic as
sending password on POST /contacts/{contactId}, but accepts only the password field.
The contact must have a non-empty email (set via create or a prior update).
The response includes has_portal_login: true when the login is linked.
POST
/
contacts
/
{contactId}
/
b2b-portal-password
Set or rotate B2B portal password
curl --request POST \
--url https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"password": "minimum8chars"
}
'import requests
url = "https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password"
payload = { "password": "minimum8chars" }
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({password: 'minimum8chars'})
};
fetch('https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password', 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/contacts/{contactId}/b2b-portal-password",
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([
'password' => 'minimum8chars'
]),
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/contacts/{contactId}/b2b-portal-password"
payload := strings.NewReader("{\n \"password\": \"minimum8chars\"\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/contacts/{contactId}/b2b-portal-password")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"password\": \"minimum8chars\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{companyName}.api.joinluminous.com/external/api/v1/contacts/{contactId}/b2b-portal-password")
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 \"password\": \"minimum8chars\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "789123",
"created_at": "2023-03-15T14:30:00Z",
"updated_at": "2023-03-15T14:30:00Z",
"status": "active",
"first_name": "John",
"last_name": "Smith",
"email": "john.smith@acmecorp.com",
"phone": "555-987-6543",
"phone_2": "555-555-5555",
"full_name": "John Smith",
"company_id": "123456",
"company": {
"id": "123456",
"name": "Acme Corporation"
},
"is_primary": true,
"receive_quotation_pdf": false,
"receive_purchase_order_pdf": false,
"receive_purchase_order_invoice_pdf": false,
"has_portal_login": false,
"companies": [
{
"id": 123,
"name": "<string>",
"is_primary": true,
"receive_quotation_pdf": true,
"receive_purchase_order_pdf": true,
"receive_purchase_order_invoice_pdf": true
}
],
"tags": [
{
"id": 123,
"name": "<string>",
"description": "<string>",
"icon": "<string>",
"color": "<string>"
}
]
}
}{
"message": "<string>"
}{
"message": "<string>"
}{
"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 contact
Body
application/json
Plain-text password (min 8 characters). Transmitted only over HTTPS.
Required string length:
8 - 255Response
Contact with updated portal login status
Show child attributes
Show child attributes
⌘I