Update an organization profile
Identity module
PATCH/organization-profiles/{id}organizationProfiles.update
An organization's profile page. New organizations start Network. 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 org.profile.write.
- OAuth scopes: org.
- 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 organization profile. |
Request body: OrganizationProfileUpdate
| Field | Type | Required | Description |
|---|---|---|---|
| about | string | null | No | About.Constraints: length 1 to 20000 |
| 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])$ |
| website_url | string (uri) | null | No | Website of the organization; https only. |
| contact_email | string (email) | null | No | Contact email of the organization, stored in lowercase. |
{
"about": "Live event production for waterfront venues.",
"search_indexing": false,
"handle": "northwind-live",
"website_url": "https://northwindlive.example/files/site-plan.pdf",
"contact_email": "alex.rivera@northwindlive.example"
}Response 200: OrganizationProfile
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the organization profile. |
| created_at | string (date-time) | Yes | When the row was created. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| organization_id | string (uuid) | Yes | Identifier of the organization. |
| about | string | null | Yes | About.Constraints: length 1 to 20000 |
| 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. |
| website_url | string (uri) | null | Yes | Website of the organization; https only. |
| contact_email | string (email) | null | Yes | Contact email of the organization, stored in lowercase. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"updated_at": "2026-10-08T14:30:00Z",
"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"about": "Live event production for waterfront venues.",
"visibility": "Private",
"search_indexing": false,
"handle": "northwind-live",
"handle_changed_at": "2026-10-08T14:30:00Z",
"website_url": "https://northwindlive.example/files/site-plan.pdf",
"contact_email": "alex.rivera@northwindlive.example"
}Code samples
curl -X PATCH "$XOS_BASE_URL/organization-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 '{"about":"Live event production for waterfront venues.","search_indexing":false,"handle":"northwind-live","website_url":"https://northwindlive.example/files/site-plan.pdf","contact_email":"alex.rivera@northwindlive.example"}'const { data, etag } = await xos.organizationProfiles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {
"about": "Live event production for waterfront venues.",
"search_indexing": false,
"handle": "northwind-live",
"website_url": "https://northwindlive.example/files/site-plan.pdf",
"contact_email": "alex.rivera@northwindlive.example"
}, { ifMatch: etag });response = xos.organization_profiles.update("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", {"about": "Live event production for waterfront venues.", "search_indexing": False, "handle": "northwind-live", "website_url": "https://northwindlive.example/files/site-plan.pdf", "contact_email": "alex.rivera@northwindlive.example"}, if_match=etag)xos organization-profiles update 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f --data '{"about":"Live event production for waterfront venues.","search_indexing":false,"handle":"northwind-live","website_url":"https://northwindlive.example/files/site-plan.pdf","contact_email":"alex.rivera@northwindlive.example"}' --if-match auto