Skip to content
XOS Developers

Create a profile visibility rule

Identity module

POST/profile-visibilityprofileVisibilityRules.create

Visibility of one profile section or field. It can be lower than the profile, never higher. Creates a profile visibility rule. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability me.profile.write.
  • OAuth scopes: me.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: ProfileVisibilityRuleCreate

profileVisibilityRules.create: ProfileVisibilityRuleCreate
FieldTypeRequiredDescription
person_idstring (uuid)YesIdentifier of the profile owner.
section"photo" | "pronouns" | "headline" | "bio" | "location" | "skills" | "certifications" | "portfolio" | "rates" | "availability" | "languages" | "references" | "links" | "organizations"YesProfile section.
visibility"Private" | "Network" | "Public"YesVisibility chosen for the section.
{
  "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "section": "photo",
  "visibility": "Private"
}

Response 201: ProfileVisibilityRule

profileVisibilityRules.create: ProfileVisibilityRule
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the profile visibility rule.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
person_idstring (uuid)YesIdentifier of the profile owner.
section"photo" | "pronouns" | "headline" | "bio" | "location" | "skills" | "certifications" | "portfolio" | "rates" | "availability" | "languages" | "references" | "links" | "organizations"YesProfile section.
visibility"Private" | "Network" | "Public"YesVisibility 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 POST "$XOS_BASE_URL/profile-visibility" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","section":"photo","visibility":"Private"}'
const { data } = await xos.profileVisibilityRules.create({
    "person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "section": "photo",
    "visibility": "Private"
  });
response = xos.profile_visibility_rules.create({"person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "section": "photo", "visibility": "Private"})
xos profile-visibility-rules create --data '{"person_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","section":"photo","visibility":"Private"}'