Update a person profile
Identity module
PATCH/person-profiles/{id}personProfiles.update
A person's profile page, owned by the person. New profiles start Private. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.
- Requires the capability me.profile.write.
- OAuth scopes: me.
- Send If-Match with the ETag you read. A stale tag returns 412; a missing tag returns 428.
- Error statuses: 400, 401, 404, 412, 422, 428, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the person profile. |
Request body: PersonProfileUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| headline | string | null | No | Headline.Constraints: length 1 to 300 |
| bio | string | null | No | Bio.Constraints: length 1 to 20000 |
| pronouns | string | null | No | Pronouns, optional.Constraints: length 1 to 300 |
| locality | string | null | No | City.Constraints: length 1 to 300 |
| country | string | null | No | ISO 3166-1 alpha-2 country code.Constraints: pattern ^[A-Z]{2}$ |
| visibility | ProfileVisibility | No | Profile visibility. Sections and fields may be set lower than the profile, never higher.Constraints: one of "Public", "Network", "Private" |
| search_indexing | boolean | No | Whether search engines may index a public profile. |
| handle | string | No | Unique handle for /u/{handle} or /c/{handle}: 3 to 40 lowercase letters, digits and single hyphens. Changeable once every 30 days; the old handle redirects for 90 days.Constraints: pattern ^[a-z0-9]([a-z0-9-]{1,38}[a-z0-9])$ |
| preferred_name | string | null | No | Name the person goes by.Constraints: length 1 to 100 |
{
"headline": "Head Rigger, Festivals and Arenas",
"bio": "Fifteen years rigging touring shows.",
"pronouns": "they/them",
"locality": "Miami",
"country": "US",
"search_indexing": false,
"handle": "northwind-live",
"preferred_name": "Alex"
}Response 200: PersonProfile
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the person profile. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| person_id | string (uuid) | Yes | Identifier of the person. |
| headline | string | null | Yes | Headline.Constraints: length 1 to 300 |
| bio | string | null | Yes | Bio.Constraints: length 1 to 20000 |
| pronouns | string | null | Yes | Pronouns, optional.Constraints: length 1 to 300 |
| locality | string | null | Yes | City.Constraints: length 1 to 300 |
| country | string | null | Yes | ISO 3166-1 alpha-2 country code.Constraints: pattern ^[A-Z]{2}$ |
| visibility | ProfileVisibility | Yes | Profile visibility. Sections and fields may be set lower than the profile, never higher.Constraints: one of "Public", "Network", "Private" |
| search_indexing | boolean | Yes | Whether search engines may index a public profile. |
| handle | string | Yes | Unique handle for /u/{handle} or /c/{handle}: 3 to 40 lowercase letters, digits and single hyphens. Changeable once every 30 days; the old handle redirects for 90 days.Constraints: pattern ^[a-z0-9]([a-z0-9-]{1,38}[a-z0-9])$ |
| handle_changed_at | string (date-time) | null | Yes | When the handle last changed; null until the first change. Set by the database. |
| preferred_name | string | null | Yes | Name the person goes by.Constraints: length 1 to 100 |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"headline": "Head Rigger, Festivals and Arenas",
"bio": "Fifteen years rigging touring shows.",
"pronouns": "they/them",
"locality": "Miami",
"country": "US",
"visibility": "Private",
"search_indexing": false,
"handle": "northwind-live",
"handle_changed_at": "2026-10-08T14:30:00Z",
"preferred_name": "Alex"
}Code samples
curl -X PATCH "$XOS_BASE_URL/person-profiles/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H 'If-Match: W/"etag-from-your-last-read"' \
-H "Content-Type: application/json" \
-d '{"headline":"Head Rigger, Festivals and Arenas","bio":"Fifteen years rigging touring shows.","pronouns":"they/them","locality":"Miami","country":"US","search_indexing":false,"handle":"northwind-live","preferred_name":"Alex"}'const { data, etag } = await xos.personProfiles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"headline": "Head Rigger, Festivals and Arenas",
"bio": "Fifteen years rigging touring shows.",
"pronouns": "they/them",
"locality": "Miami",
"country": "US",
"search_indexing": false,
"handle": "northwind-live",
"preferred_name": "Alex"
}, { ifMatch: etag });response = xos.person_profiles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"headline": "Head Rigger, Festivals and Arenas", "bio": "Fifteen years rigging touring shows.", "pronouns": "they/them", "locality": "Miami", "country": "US", "search_indexing": False, "handle": "northwind-live", "preferred_name": "Alex"}, if_match=etag)xos person-profiles update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"headline":"Head Rigger, Festivals and Arenas","bio":"Fifteen years rigging touring shows.","pronouns":"they/them","locality":"Miami","country":"US","search_indexing":false,"handle":"northwind-live","preferred_name":"Alex"}' --if-match auto