---
title: "Update a person"
method: PATCH
path: "/v1/people/{person_id}"
tags: ["People"]
---

# Update a person

`PATCH /v1/people/{person_id}`

## Request

- Base URL: `https://api.yardstick.team`
- URL: `https://api.yardstick.team/v1/people/{person_id}`
- Auth: HTTP bearer

Update a person

**Required scopes:** `people:write`

**Example (curl):**

```bash
curl -X PATCH https://api.yardstick.team/v1/people/per_abc123 \
  -H 'Authorization: Bearer ys_sk_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"phone":"+1-555-0100"}'
```

**Example (TypeScript):**

```ts
await fetch("https://api.yardstick.team/v1/people/per_abc123", {
  method: "PATCH",
  headers: {
    Authorization: `Bearer ${process.env.YS_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ phone: "+1-555-0100" }),
});
```

## Path parameters

- `person_id` string, required

## Headers

- `Idempotency-Key` string
- `X-Request-Id` string

## Request body

- object
  - `name` string
  - `email` string, email
  - `phone` string, nullable
  - `linkedin_url` string, uri, nullable
  - `resume_url` string, uri, nullable
  - `notes` string, nullable

## Response `200`

Success

- Person: Canonical person record for an applicant, lead, or contact.
  - `id` string, required: Display id, e.g. `per_<base32>`
  - `object` 'person', required
  - `name` string, nullable, required
  - `email` string, nullable, required
  - `phone` string, nullable, required
  - `linkedin_url` string, nullable, required
  - `resume_url` string, nullable, required
  - `notes` string, nullable, required
  - `livemode` boolean, required

## Other responses

- `400`: Invalid request
- `401`: Authentication failure
- `403`: Permission denied (scope or feature flag)
- `404`: Resource not found. The error uses the resource-specific code and param names the exact body field or path parameter that referenced it.
- `409`: Conflict (e.g. idempotency key reuse with different body)
- `429`: Rate limited
- `500`: Internal error

---

[API](https://skmtc.dev/yardstick/apis/yardstick-public-api.md) · [All operations](https://skmtc.dev/yardstick/apis/yardstick-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/yardstick/apis/yardstick-public-api/revisions/bef1d2eaaaa1?raw)