> ## 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. # 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. ## OpenAPI ````yaml /api-reference/openapi-v1.json patch /v1/persons/{id} openapi: 3.1.0 info: title: Stardex API (v1) version: 1.0.0 description: >- Stardex ATS API — manage candidates, jobs, companies, and recruiting workflows. servers: - url: https://api.stardex.ai description: Production API server security: - bearerAuth: [] tags: - name: Persons description: Manage person records — contacts, work history, and custom fields. - name: Jobs description: Manage job postings — pipeline stages, team members, and custom fields. - name: Candidates description: Manage candidate records and pipeline stage transitions. - name: Companies description: Browse and retrieve company records. - name: Lists description: Create, search, and retrieve saved person and company lists. - name: Person Activities description: Create and manage activity records (notes, emails, meetings) for persons. - name: Team Members description: List team members for use in search filters and assignments. - name: Custom Fields description: Retrieve custom field definitions and tag options for search filters. paths: /v1/persons/{id}: patch: tags: - Persons summary: Update person description: >- 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. operationId: updatePerson parameters: - in: path name: id required: true schema: type: string description: Person ID requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePersonRequest' responses: '200': description: Person updated content: application/json: schema: $ref: '#/components/schemas/UpdatePersonResponse' example: success: true data: message: Person updated successfully '400': description: Validation error content: application/json: schema: type: object properties: success: type: boolean enum: - false description: Always false for error responses. error: type: object properties: code: type: string description: >- Machine-readable error code (e.g. "VALIDATION_ERROR", "NOT_FOUND"). message: type: string description: Human-readable error description. required: - code - message required: - success - error '404': description: Resource not found content: application/json: schema: type: object properties: success: type: boolean enum: - false description: Always false for error responses. error: type: object properties: code: type: string description: >- Machine-readable error code (e.g. "VALIDATION_ERROR", "NOT_FOUND"). message: type: string description: Human-readable error description. required: - code - message required: - success - error '500': description: Internal server error content: application/json: schema: type: object properties: success: type: boolean enum: - false description: Always false for error responses. error: type: object properties: code: type: string description: >- Machine-readable error code (e.g. "VALIDATION_ERROR", "NOT_FOUND"). message: type: string description: Human-readable error description. required: - code - message required: - success - error components: schemas: UpdatePersonRequest: type: object properties: linkedin_url: type: string description: LinkedIn profile URL. emails: type: array items: $ref: '#/components/schemas/PersonContactValue' description: >- Replace all email addresses. Cannot be combined with work_email or personal_email. phone_numbers: type: array items: $ref: '#/components/schemas/PersonContactValue' description: >- Replace all phone numbers. Cannot be combined with work_phone or mobile_phone. name: type: string description: Full name. first_name: type: string description: First name. last_name: type: string description: Last name. current_job_title: type: string description: Current job title. company_name: type: string description: Current employer company name. location: type: string description: Location (e.g. city, region, or country). linkedin_headline: type: string description: LinkedIn headline text. address: type: string description: Physical/mailing address. enrich_record: type: boolean description: When true, triggers background enrichment via data providers. work_email: type: string description: Work email address. personal_email: type: string description: Personal email address. mobile_phone: type: string description: Mobile phone number. work_phone: type: string description: Work phone number. job_id: type: string description: >- Job UUID to add this person to that job pipeline as a candidate (creates the candidacy). Get IDs from POST /v1/jobs/search. do_not_contact: type: boolean description: >- Set to true to mark this person as do-not-contact, or false to clear the flag. do_not_contact_reason: type: string description: >- 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: type: array items: type: object properties: attribute_id: type: string format: uuid description: >- Custom attribute definition UUID. Get from GET /v1/custom-fields/persons. value: anyOf: - type: string - type: number - type: boolean - type: 'null' - type: 'null' description: >- For scalar types (text, number, date, url, boolean): the value to set, or null to clear. For single-select: pass the tag NAME (e.g. "Remote", "On-site") or the tag option UUID from GET /v1/custom-fields/persons. A new tag is auto-created only for a name that does not exist yet; an unknown UUID is ignored. Null to clear. add_values: type: array items: type: string description: >- Tags to add for multi-select fields. Pass tag NAMES (e.g. ["Engineer", "Designer"]) or tag option UUIDs from GET /v1/custom-fields/persons. A new tag is auto-created only for a name that does not exist yet; an unknown UUID is ignored. Duplicates silently skipped. remove_values: type: array items: type: string description: >- Tags to remove for multi-select fields. Pass tag NAMES or tag option UUIDs. add_team_member_ids: type: array items: type: string format: uuid description: >- Team member UUIDs to add for multi-team-member fields. Get IDs from GET /v1/team-members. remove_team_member_ids: type: array items: type: string format: uuid description: Team member UUIDs to remove for multi-team-member fields. clear_all: type: boolean description: >- When true, removes all existing values for this multi-select or multi-team-member attribute. Combine with add_values/add_team_member_ids to replace all values in one call. required: - attribute_id description: >- 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. UpdatePersonResponse: type: object properties: success: type: boolean enum: - true data: type: object properties: message: type: string required: - message required: - success - data PersonContactValue: type: object properties: contact_data_type: type: - string - 'null' description: >- Contact category. Values: work, personal, mobile, home, other, or null if unknown. value: type: string description: Email address or phone number string. required: - contact_data_type - value securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Authenticate with a Bearer token: API key, OAuth token, or session token. ````