People

Update a person

Update a person

Required scopes: people:write

Example (curl):

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):

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" }),
});
patch/v1/people/{person_id}

Request

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

Path parameters

person_idstring required

Headers

Idempotency-Keystring

Supported for safe retry. Reuse the same key to receive the cached response without repeating the operation.

X-Request-Idstring

Optional caller-supplied request identifier. Values must match ^[A-Za-z0-9_-]{1,128}$; a valid value is echoed in the response X-Request-Id header, otherwise the API generates one.

Request body

namestring
emailstring email
phonestring nullable
linkedin_urlstring uri nullable
resume_urlstring uri nullable
notesstring nullable

Response

Success

idstring required

Display id, e.g. per_<base32>

object'person' required
namestring nullable required
emailstring nullable required
phonestring nullable required
linkedin_urlstring nullable required
resume_urlstring nullable required
notesstring nullable required
livemodeboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.