Organization

Updates the given organization's provided fields.

Changed on

Only the fields present in the body are changed, and only those the caller may change. An auto-join domain is rejected when it is malformed or already claimed by another organization; enabling auto-join without a claimed domain is rejected as well.

patch/organizations/{organizationId}

Request

  • Base URL
    https://api.rapidata.ai
  • URL
    https://api.rapidata.ai/organizations/{organizationId}
  • Auth
    OpenID Connect (https://auth.rapidata.ai/.well-known/openid-configuration, scopes: openid, profile, email, offline_access, api)

Path parameters

organizationIdstring required

The id of the organization to update.

Request body

namestring

The new human-readable name, if changing it.

autoJoinDomainstring nullable

The email domain to claim for auto-join, or null to release the claim. New customers who sign up with a confirmed email on this domain join this organization instead of getting a personal one, once auto-join is enabled. Existing customers are never moved.

autoJoinEnabledboolean

Whether to auto-join new customers signing up on the claimed domain.

Response

No Content

Changes

  • 9da534659e5fRevision changes
    • info

      the security scope api was added to the endpoint's security scheme OpenIdConnect

    • info

      added the new optional request property

    • info

      added the new optional request property

  • f5235270ce3cRevision changes
    • warning

      removed the request property