Skip to content

Create an organization profile

Identity module

POST/organization-profilesorganizationProfiles.create

An organization's profile page. New organizations start Network. Creates an organization profile. 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 org.profile.write.
  • OAuth scopes: org.
  • 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: OrganizationProfileCreate

organizationProfiles.create: OrganizationProfileCreate
FieldTypeRequiredDescription
organization_idstring (uuid)YesIdentifier of the organization.
aboutstring | nullNoAbout.Constraints: length 1 to 20000
visibilityProfileVisibilityYesProfile visibility. Sections and fields may be set lower than the profile, never higher.Constraints: one of "Public", "Network", "Private"
search_indexingbooleanYesWhether search engines may index a public profile.
{
  "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "about": "Live event production for waterfront venues.",
  "visibility": "Private",
  "search_indexing": false
}

Response 201: OrganizationProfile

organizationProfiles.create: OrganizationProfile
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the organization profile.
created_atstring (date-time)YesWhen the row was created.
updated_atstring (date-time)YesWhen the row was last updated.
organization_idstring (uuid)YesIdentifier of the organization.
aboutstring | nullYesAbout.Constraints: length 1 to 20000
visibilityProfileVisibilityYesProfile visibility. Sections and fields may be set lower than the profile, never higher.Constraints: one of "Public", "Network", "Private"
search_indexingbooleanYesWhether search engines may index a public profile.
handlestringYesUnique 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_atstring (date-time) | nullYesWhen the handle last changed; null until the first change. Set by the database.
website_urlstring (uri) | nullYesWebsite of the organization; https only.
contact_emailstring (email) | nullYesContact 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 POST "$XOS_BASE_URL/organization-profiles" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","about":"Live event production for waterfront venues.","visibility":"Private","search_indexing":false}'
const { data } = await xos.organizationProfiles.create({
    "organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "about": "Live event production for waterfront venues.",
    "visibility": "Private",
    "search_indexing": false
  });
response = xos.organization_profiles.create({"organization_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "about": "Live event production for waterfront venues.", "visibility": "Private", "search_indexing": False})
xos organization-profiles create --data '{"organization_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","about":"Live event production for waterfront venues.","visibility":"Private","search_indexing":false}'