Skip to content
XOS Developers

Delete a profile visibility rule

Identity module

DELETE/profile-visibility/{id}profileVisibilityRules.delete

Visibility of one profile section or field. It can be lower than the profile, never higher. Soft-deletes the profile visibility rule: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability me.profile.write.
  • OAuth scopes: me.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

profileVisibilityRules.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the profile visibility rule.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/profile-visibility/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.profileVisibilityRules.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.profile_visibility_rules.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos profile-visibility-rules delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f