Update person
curl --request PATCH \
--url https://api.stardex.ai/v1/persons/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"linkedin_url": "<string>",
"emails": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": true
}
],
"phone_numbers": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": true
}
],
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"current_job_title": "<string>",
"company_name": "<string>",
"location": "<string>",
"linkedin_headline": "<string>",
"address": "<string>",
"enrich_record": true,
"work_email": "<string>",
"personal_email": "<string>",
"mobile_phone": "<string>",
"work_phone": "<string>",
"job_id": "<string>",
"sourced_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"do_not_contact": true,
"do_not_contact_reason": "<string>",
"do_not_contact_expiration_date": "2023-11-07T05:31:56Z",
"custom_fields": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"add_values": [
"<string>"
],
"remove_values": [
"<string>"
],
"add_team_member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"remove_team_member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add_company_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"remove_company_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"clear_all": true
}
]
}
'import requests
url = "https://api.stardex.ai/v1/persons/{id}"
payload = {
"linkedin_url": "<string>",
"emails": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": True
}
],
"phone_numbers": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": True
}
],
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"current_job_title": "<string>",
"company_name": "<string>",
"location": "<string>",
"linkedin_headline": "<string>",
"address": "<string>",
"enrich_record": True,
"work_email": "<string>",
"personal_email": "<string>",
"mobile_phone": "<string>",
"work_phone": "<string>",
"job_id": "<string>",
"sourced_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"do_not_contact": True,
"do_not_contact_reason": "<string>",
"do_not_contact_expiration_date": "2023-11-07T05:31:56Z",
"custom_fields": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"add_values": ["<string>"],
"remove_values": ["<string>"],
"add_team_member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"remove_team_member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add_company_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"remove_company_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"clear_all": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
linkedin_url: '<string>',
emails: [{contact_data_type: '<string>', value: '<string>', is_preferred: true}],
phone_numbers: [{contact_data_type: '<string>', value: '<string>', is_preferred: true}],
name: '<string>',
first_name: '<string>',
last_name: '<string>',
current_job_title: '<string>',
company_name: '<string>',
location: '<string>',
linkedin_headline: '<string>',
address: '<string>',
enrich_record: true,
work_email: '<string>',
personal_email: '<string>',
mobile_phone: '<string>',
work_phone: '<string>',
job_id: '<string>',
sourced_by: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
do_not_contact: true,
do_not_contact_reason: '<string>',
do_not_contact_expiration_date: '2023-11-07T05:31:56Z',
custom_fields: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
value: '<string>',
add_values: ['<string>'],
remove_values: ['<string>'],
add_team_member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
remove_team_member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add_company_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
remove_company_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
clear_all: true
}
]
})
};
fetch('https://api.stardex.ai/v1/persons/{id}', 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/persons/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'linkedin_url' => '<string>',
'emails' => [
[
'contact_data_type' => '<string>',
'value' => '<string>',
'is_preferred' => true
]
],
'phone_numbers' => [
[
'contact_data_type' => '<string>',
'value' => '<string>',
'is_preferred' => true
]
],
'name' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'current_job_title' => '<string>',
'company_name' => '<string>',
'location' => '<string>',
'linkedin_headline' => '<string>',
'address' => '<string>',
'enrich_record' => true,
'work_email' => '<string>',
'personal_email' => '<string>',
'mobile_phone' => '<string>',
'work_phone' => '<string>',
'job_id' => '<string>',
'sourced_by' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'do_not_contact' => true,
'do_not_contact_reason' => '<string>',
'do_not_contact_expiration_date' => '2023-11-07T05:31:56Z',
'custom_fields' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>',
'add_values' => [
'<string>'
],
'remove_values' => [
'<string>'
],
'add_team_member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'remove_team_member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add_company_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'remove_company_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'clear_all' => true
]
]
]),
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/persons/{id}"
payload := strings.NewReader("{\n \"linkedin_url\": \"<string>\",\n \"emails\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"phone_numbers\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"current_job_title\": \"<string>\",\n \"company_name\": \"<string>\",\n \"location\": \"<string>\",\n \"linkedin_headline\": \"<string>\",\n \"address\": \"<string>\",\n \"enrich_record\": true,\n \"work_email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"work_phone\": \"<string>\",\n \"job_id\": \"<string>\",\n \"sourced_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"do_not_contact\": true,\n \"do_not_contact_reason\": \"<string>\",\n \"do_not_contact_expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_fields\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"add_values\": [\n \"<string>\"\n ],\n \"remove_values\": [\n \"<string>\"\n ],\n \"add_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"clear_all\": true\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.stardex.ai/v1/persons/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"linkedin_url\": \"<string>\",\n \"emails\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"phone_numbers\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"current_job_title\": \"<string>\",\n \"company_name\": \"<string>\",\n \"location\": \"<string>\",\n \"linkedin_headline\": \"<string>\",\n \"address\": \"<string>\",\n \"enrich_record\": true,\n \"work_email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"work_phone\": \"<string>\",\n \"job_id\": \"<string>\",\n \"sourced_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"do_not_contact\": true,\n \"do_not_contact_reason\": \"<string>\",\n \"do_not_contact_expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_fields\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"add_values\": [\n \"<string>\"\n ],\n \"remove_values\": [\n \"<string>\"\n ],\n \"add_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"clear_all\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/persons/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"linkedin_url\": \"<string>\",\n \"emails\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"phone_numbers\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"current_job_title\": \"<string>\",\n \"company_name\": \"<string>\",\n \"location\": \"<string>\",\n \"linkedin_headline\": \"<string>\",\n \"address\": \"<string>\",\n \"enrich_record\": true,\n \"work_email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"work_phone\": \"<string>\",\n \"job_id\": \"<string>\",\n \"sourced_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"do_not_contact\": true,\n \"do_not_contact_reason\": \"<string>\",\n \"do_not_contact_expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_fields\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"add_values\": [\n \"<string>\"\n ],\n \"remove_values\": [\n \"<string>\"\n ],\n \"add_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"clear_all\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "Person updated successfully"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "PERSON_DELETION_REQUESTED",
"message": "This person asked to be removed from your workspace and can't be added again."
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Persons
Update person
Update an existing person’s information including contact details, job title, company, do-not-contact status, and custom field values. Only provided fields are updated; omitted fields remain unchanged.
Do-not-contact: Pass do_not_contact: true to flag the person or false to clear it. Optionally include a do_not_contact_reason (free text) and do_not_contact_expiration_date (ISO 8601 timestamp). Pass null for an indefinite do-not-contact. When the expiration field is omitted on a new flag, the do-not-contact is indefinite; when omitted on an existing flag, the current expiration is preserved.
PATCH
/
v1
/
persons
/
{id}
Update person
curl --request PATCH \
--url https://api.stardex.ai/v1/persons/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"linkedin_url": "<string>",
"emails": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": true
}
],
"phone_numbers": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": true
}
],
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"current_job_title": "<string>",
"company_name": "<string>",
"location": "<string>",
"linkedin_headline": "<string>",
"address": "<string>",
"enrich_record": true,
"work_email": "<string>",
"personal_email": "<string>",
"mobile_phone": "<string>",
"work_phone": "<string>",
"job_id": "<string>",
"sourced_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"do_not_contact": true,
"do_not_contact_reason": "<string>",
"do_not_contact_expiration_date": "2023-11-07T05:31:56Z",
"custom_fields": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"add_values": [
"<string>"
],
"remove_values": [
"<string>"
],
"add_team_member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"remove_team_member_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"add_company_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"remove_company_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"clear_all": true
}
]
}
'import requests
url = "https://api.stardex.ai/v1/persons/{id}"
payload = {
"linkedin_url": "<string>",
"emails": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": True
}
],
"phone_numbers": [
{
"contact_data_type": "<string>",
"value": "<string>",
"is_preferred": True
}
],
"name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"current_job_title": "<string>",
"company_name": "<string>",
"location": "<string>",
"linkedin_headline": "<string>",
"address": "<string>",
"enrich_record": True,
"work_email": "<string>",
"personal_email": "<string>",
"mobile_phone": "<string>",
"work_phone": "<string>",
"job_id": "<string>",
"sourced_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"do_not_contact": True,
"do_not_contact_reason": "<string>",
"do_not_contact_expiration_date": "2023-11-07T05:31:56Z",
"custom_fields": [
{
"attribute_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"value": "<string>",
"add_values": ["<string>"],
"remove_values": ["<string>"],
"add_team_member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"remove_team_member_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"add_company_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"remove_company_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
"clear_all": True
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
linkedin_url: '<string>',
emails: [{contact_data_type: '<string>', value: '<string>', is_preferred: true}],
phone_numbers: [{contact_data_type: '<string>', value: '<string>', is_preferred: true}],
name: '<string>',
first_name: '<string>',
last_name: '<string>',
current_job_title: '<string>',
company_name: '<string>',
location: '<string>',
linkedin_headline: '<string>',
address: '<string>',
enrich_record: true,
work_email: '<string>',
personal_email: '<string>',
mobile_phone: '<string>',
work_phone: '<string>',
job_id: '<string>',
sourced_by: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
do_not_contact: true,
do_not_contact_reason: '<string>',
do_not_contact_expiration_date: '2023-11-07T05:31:56Z',
custom_fields: [
{
attribute_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
value: '<string>',
add_values: ['<string>'],
remove_values: ['<string>'],
add_team_member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
remove_team_member_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
add_company_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
remove_company_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
clear_all: true
}
]
})
};
fetch('https://api.stardex.ai/v1/persons/{id}', 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/persons/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'linkedin_url' => '<string>',
'emails' => [
[
'contact_data_type' => '<string>',
'value' => '<string>',
'is_preferred' => true
]
],
'phone_numbers' => [
[
'contact_data_type' => '<string>',
'value' => '<string>',
'is_preferred' => true
]
],
'name' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'current_job_title' => '<string>',
'company_name' => '<string>',
'location' => '<string>',
'linkedin_headline' => '<string>',
'address' => '<string>',
'enrich_record' => true,
'work_email' => '<string>',
'personal_email' => '<string>',
'mobile_phone' => '<string>',
'work_phone' => '<string>',
'job_id' => '<string>',
'sourced_by' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'do_not_contact' => true,
'do_not_contact_reason' => '<string>',
'do_not_contact_expiration_date' => '2023-11-07T05:31:56Z',
'custom_fields' => [
[
'attribute_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'value' => '<string>',
'add_values' => [
'<string>'
],
'remove_values' => [
'<string>'
],
'add_team_member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'remove_team_member_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'add_company_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'remove_company_ids' => [
'3c90c3cc-0d44-4b50-8888-8dd25736052a'
],
'clear_all' => true
]
]
]),
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/persons/{id}"
payload := strings.NewReader("{\n \"linkedin_url\": \"<string>\",\n \"emails\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"phone_numbers\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"current_job_title\": \"<string>\",\n \"company_name\": \"<string>\",\n \"location\": \"<string>\",\n \"linkedin_headline\": \"<string>\",\n \"address\": \"<string>\",\n \"enrich_record\": true,\n \"work_email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"work_phone\": \"<string>\",\n \"job_id\": \"<string>\",\n \"sourced_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"do_not_contact\": true,\n \"do_not_contact_reason\": \"<string>\",\n \"do_not_contact_expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_fields\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"add_values\": [\n \"<string>\"\n ],\n \"remove_values\": [\n \"<string>\"\n ],\n \"add_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"clear_all\": true\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", 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.patch("https://api.stardex.ai/v1/persons/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"linkedin_url\": \"<string>\",\n \"emails\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"phone_numbers\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"current_job_title\": \"<string>\",\n \"company_name\": \"<string>\",\n \"location\": \"<string>\",\n \"linkedin_headline\": \"<string>\",\n \"address\": \"<string>\",\n \"enrich_record\": true,\n \"work_email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"work_phone\": \"<string>\",\n \"job_id\": \"<string>\",\n \"sourced_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"do_not_contact\": true,\n \"do_not_contact_reason\": \"<string>\",\n \"do_not_contact_expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_fields\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"add_values\": [\n \"<string>\"\n ],\n \"remove_values\": [\n \"<string>\"\n ],\n \"add_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"clear_all\": true\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stardex.ai/v1/persons/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"linkedin_url\": \"<string>\",\n \"emails\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"phone_numbers\": [\n {\n \"contact_data_type\": \"<string>\",\n \"value\": \"<string>\",\n \"is_preferred\": true\n }\n ],\n \"name\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"current_job_title\": \"<string>\",\n \"company_name\": \"<string>\",\n \"location\": \"<string>\",\n \"linkedin_headline\": \"<string>\",\n \"address\": \"<string>\",\n \"enrich_record\": true,\n \"work_email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"mobile_phone\": \"<string>\",\n \"work_phone\": \"<string>\",\n \"job_id\": \"<string>\",\n \"sourced_by\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"do_not_contact\": true,\n \"do_not_contact_reason\": \"<string>\",\n \"do_not_contact_expiration_date\": \"2023-11-07T05:31:56Z\",\n \"custom_fields\": [\n {\n \"attribute_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"value\": \"<string>\",\n \"add_values\": [\n \"<string>\"\n ],\n \"remove_values\": [\n \"<string>\"\n ],\n \"add_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_team_member_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"add_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"remove_company_ids\": [\n \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n ],\n \"clear_all\": true\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"data": {
"message": "Person updated successfully"
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}{
"success": false,
"error": {
"code": "PERSON_DELETION_REQUESTED",
"message": "This person asked to be removed from your workspace and can't be added again."
}
}{
"success": false,
"error": {
"code": "<string>",
"message": "<string>",
"details": {}
}
}Authorizations
Authenticate with a Bearer token: API key, OAuth token, or session token.
Path Parameters
Person ID
Body
application/json
LinkedIn profile URL.
Replace all email addresses. Cannot be combined with work_email or personal_email.
Show child attributes
Show child attributes
Replace all phone numbers. Cannot be combined with work_phone or mobile_phone.
Show child attributes
Show child attributes
Full name.
First name.
Last name.
Current job title.
Current employer company name.
Location (e.g. city, region, or country).
LinkedIn headline text.
Physical/mailing address.
When true, triggers background enrichment via data providers.
Work email address.
Personal email address.
Mobile phone number.
Work phone number.
Job UUID to add this person to that job pipeline as a candidate (creates the candidacy). Get IDs from POST /v1/jobs/search.
UUID of the team member who sourced this candidate, recorded as "Sourced by" on the candidacy created by job_id. Get IDs from GET /v1/team-members. Requires job_id. Only applies to API-key requests; requests made as a signed-in user (session or OAuth, including MCP) always credit that user. If the person is already a candidate on the job, the existing sourcer is kept.
Set to true to mark this person as do-not-contact, or false to clear the flag.
Free-text reason for the do-not-contact flag (e.g. "Requested removal from outreach"). Only meaningful when do_not_contact is true. When omitted, any existing reason is preserved.
ISO 8601 timestamp when do-not-contact should automatically expire. Only meaningful when do_not_contact is true. Pass an explicit date to set a custom expiration, or null for an indefinite do-not-contact. When omitted on a new do-not-contact flag, the flag is indefinite. When omitted on an existing do-not-contact flag, the current expiration is preserved.
Custom field values to update. Each attribute_id should appear once. Get attribute definitions from GET /v1/custom-fields/persons. For select fields, pass the tag NAME (e.g. "Remote") or the tag option UUID returned in that definition.
Show child attributes
Show child attributes
Was this page helpful?