Saltar al contenido

Update a profile visibility rule

Módulo Identity

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.

  • Requiere la capacidad me.profile.write.
  • Alcances de OAuth: me.
  • Envía If-Match con el ETag que leíste. Una etiqueta desactualizada devuelve 412; si falta, devuelve 428.
  • Estados de error: 400, 401, 404, 412, 422, 428, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

profileVisibilityRules.update: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the profile visibility rule.

Cuerpo de la solicitud: ProfileVisibilityRuleUpdate

profileVisibilityRules.update: ProfileVisibilityRuleUpdate
CampoTipoObligatorioDescripción
visibility"Private" | "Network" | "Public"NoVisibility chosen for the section.
{
  "visibility": "Private"
}

Respuesta 200: ProfileVisibilityRule

profileVisibilityRules.update: ProfileVisibilityRule
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the profile visibility rule.
created_atstring (date-time)SíWhen the row was created.
updated_atstring (date-time)SíWhen the row was last updated.
person_idstring (uuid)SíIdentifier of the profile owner.
section"photo" | "pronouns" | "headline" | "bio" | "location" | "skills" | "certifications" | "portfolio" | "rates" | "availability" | "languages" | "references" | "links" | "organizations"SíProfile section.
visibility"Private" | "Network" | "Public"Sí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"
}

Ejemplos de código

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