curl --request POST \
--url https://api.stardex.ai/v1/jobs/{id}/referral-partners \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_split_percentage": 123
}
'import requests
url = "https://api.stardex.ai/v1/jobs/{id}/referral-partners"
payload = {
"client_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_split_percentage": 123
}
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({
client_contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
default_split_percentage: 123
})
};
fetch('https://api.stardex.ai/v1/jobs/{id}/referral-partners', 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://api.stardex.ai/v1/jobs/{id}/referral-partners",
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([
'client_contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'default_split_percentage' => 123
]),
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://api.stardex.ai/v1/jobs/{id}/referral-partners"
payload := strings.NewReader("{\n \"client_contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_split_percentage\": 123\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://api.stardex.ai/v1/jobs/{id}/referral-partners")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_split_percentage\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/jobs/{id}/referral-partners")
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 \"client_contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_split_percentage\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"client_contact_id": "d2e3f4a5-b6c7-8901-defa-234567890123",
"person_id": "e3f4a5b6-c7d8-9012-efab-345678901234",
"name": "Priya Natarajan",
"title": "Managing Partner",
"image_url": "https://example.com/priya-natarajan.png",
"company_id": "678e9012-a34b-56c7-d890-123456789abc",
"company_name": "Northwind Ventures",
"default_split_percentage": 10,
"default_mode": "off_the_top",
"created_at": "2024-01-12T15:00:00Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Add job referral partner
Adds a client contact as a referral partner on the job. Any live client contact in your workspace can be added, from any company; find IDs with GET /v1/client-contacts?keywords=.... Returns 409 REFERRAL_PARTNER_EXISTS when the contact is already a partner on this job, 404 when the contact is deleted or not in your workspace, and 422 INVALID_SPLIT_PERCENTAGE when default_split_percentage is not more than 0 and at most 100. Session and OAuth callers need the admin role or the “Edit jobs” permission. Needs fees:write for API keys.
curl --request POST \
--url https://api.stardex.ai/v1/jobs/{id}/referral-partners \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"client_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_split_percentage": 123
}
'import requests
url = "https://api.stardex.ai/v1/jobs/{id}/referral-partners"
payload = {
"client_contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"default_split_percentage": 123
}
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({
client_contact_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
default_split_percentage: 123
})
};
fetch('https://api.stardex.ai/v1/jobs/{id}/referral-partners', 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://api.stardex.ai/v1/jobs/{id}/referral-partners",
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([
'client_contact_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'default_split_percentage' => 123
]),
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://api.stardex.ai/v1/jobs/{id}/referral-partners"
payload := strings.NewReader("{\n \"client_contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_split_percentage\": 123\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://api.stardex.ai/v1/jobs/{id}/referral-partners")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"client_contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_split_percentage\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/jobs/{id}/referral-partners")
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 \"client_contact_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"default_split_percentage\": 123\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"client_contact_id": "d2e3f4a5-b6c7-8901-defa-234567890123",
"person_id": "e3f4a5b6-c7d8-9012-efab-345678901234",
"name": "Priya Natarajan",
"title": "Managing Partner",
"image_url": "https://example.com/priya-natarajan.png",
"company_id": "678e9012-a34b-56c7-d890-123456789abc",
"company_name": "Northwind Ventures",
"default_split_percentage": 10,
"default_mode": "off_the_top",
"created_at": "2024-01-12T15:00:00Z"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Path Parameters
Job UUID
Body
Client contact UUID to add as a referral partner. Any live client contact in your workspace can be added, from any company. Find IDs with GET /v1/client-contacts?keywords=...
Default percentage offered to this partner when a placement is logged on the job. More than 0 and at most 100, rounded to 2 decimals. Null when no default is set.
How the partner is paid on placements by default. Defaults to off_the_top.
off_the_top, team_pool Was this page helpful?