Sign in
organizations

Update an organization's name, slug, or settings.

Changed on

Capability changes are restricted to platform admins.

patch/organizations/{id}

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/organizations/{id}
  • Auth: none declared

Path parameters

idstring required

Request body

namestring
slugstring
avatarUrlstring uri nullable
supportEmailstring email nullable
capabilitiesstring[]
enabledReleaseChannelsstring[]
sandboxRetentionDaysinteger nullable
defaultSandboxSizestring nullable
sandboxArtifactMirrorsboolean
allowSessionShareViewboolean
allowSessionShareEditboolean
sharingSettingsobject
defaultSessionShare'private' | 'view' | 'edit'

Response

Successful response

Changes

  • 5ab9b204a215Revision changes
    • warning

      changed the pattern of the request property / from ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$ to ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

  • d13610169115Revision changes
    • info

      added the new optional request property