Skip to main content
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>"
    }
  ],
  "phone_numbers": [
    {
      "contact_data_type": "<string>",
      "value": "<string>"
    }
  ],
  "name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "current_job_title": "<string>",
  "company_name": "<string>",
  "linkedin_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>",
  "do_not_contact": true,
  "do_not_contact_reason": "<string>",
  "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"
      ],
      "clear_all": true
    }
  ]
}
'
{
  "success": true,
  "data": {
    "message": "Person updated successfully"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.stardex.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Authenticate with a Bearer token: API key, OAuth token, or session token.

Path Parameters

​
id
string
required

Person ID

Body

application/json
​
linkedin_url
string

LinkedIn profile URL.

​
emails
object[]

Replace all email addresses.

​
phone_numbers
object[]

Replace all phone numbers.

​
name
string

Full name.

​
first_name
string

First name.

​
last_name
string

Last name.

​
current_job_title
string

Current job title.

​
company_name
string

Current employer company name.

​
linkedin_location
string

Location from LinkedIn.

​
linkedin_headline
string

LinkedIn headline text.

​
address
string

Physical/mailing address.

​
enrich_record
boolean

When true, triggers background enrichment via data providers.

​
work_email
string

Work email address.

​
personal_email
string

Personal email address.

​
mobile_phone
string

Mobile phone number.

​
work_phone
string

Work phone number.

​
job_id
string

Job UUID to add this person as a candidate. Get IDs from POST /v1/jobs/search.

​
do_not_contact
boolean

Set to true to mark this person as do-not-contact, or false to clear the flag.

​
do_not_contact_reason
string

Free-text reason for the do-not-contact flag (e.g. "Requested removal from outreach"). Only meaningful when do_not_contact is true.

​
custom_fields
object[]

Custom field values to update. Each attribute_id should appear once. Get attribute definitions from GET /v1/custom-fields/persons. IMPORTANT: For select fields, pass human-readable tag NAMES (e.g. "Remote"), never UUIDs.

Response

Person updated

​
success
enum<boolean>
required
Available options:
true
​
data
object
required