Organizations

Update an organization.

Changed on

Updates the editable profile fields — name, slug, or icon — of the organization identified by orgId. A changed slug must still be available.

Requires the owner or admin role in the organization.

put/api/v1/orgs/{orgId}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

orgIdstring required

Request body

displayNamestring nullable required

Optional replacement display name.

slugstring nullable required

Optional replacement slug.

iconUrlstring nullable required

Optional replacement icon data URL.

Response

OK

idstring required

Stable organization identifier.

slugstring nullable required

Organization slug.

displayNamestring required

Human-readable organization name.

iconUrlstring nullable required

Optional organization icon data URL.

rolestring nullable required

Current user's role in the organization, when available.

createdAtUtcstring date-time required

UTC timestamp when the organization was created.

activatedAtUtcstring date-time nullable required

UTC timestamp when the organization became active.

autoInviteSameDomainEnabledboolean required

Whether same-domain onboarding is enabled.

autoInviteSameDomainstring nullable required

Normalized domain currently claimed for auto-invites.

autoInviteDefaultRolestring required

Role assigned to auto-created same-domain invitations.

autoInviteSameDomainCanEnableboolean required

Whether the organization can enable same-domain onboarding.

autoInviteSameDomainBlockReasonstring nullable required

Reason enabling is blocked, when any.

Changes

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status