Update a profile visibility rule
Identity module
PATCH/profile-visibility/{id}profileVisibilityRules.update
Visibility of one profile section or field. It can be lower than the profile, never higher. 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 profile visibility rule. |
Request body: ProfileVisibilityRuleUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| visibility | "Private" | "Network" | "Public" | No | Visibility chosen for the section. |
{
"visibility": "Private"
}Response 200: ProfileVisibilityRule
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the profile visibility rule. |
| 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 profile owner. |
| section | "photo" | "pronouns" | "headline" | "bio" | "location" | "skills" | "certifications" | "portfolio" | "rates" | "availability" | "languages" | "references" | "links" | "organizations" | Yes | Profile section. |
| visibility | "Private" | "Network" | "Public" | Yes | Visibility chosen for the section. |
{
"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",
"section": "photo",
"visibility": "Private"
}Code samples
curl -X PATCH "$XOS_BASE_URL/profile-visibility/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 '{"visibility":"Private"}'const { data, etag } = await xos.profileVisibilityRules.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"visibility": "Private"
}, { ifMatch: etag });response = xos.profile_visibility_rules.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"visibility": "Private"}, if_match=etag)xos profile-visibility-rules update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"visibility":"Private"}' --if-match auto