Organizations

✨ Update organization

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Update organization details including title, embed domains, and Plugins settings.
patch/api/organizations/{id}

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/organizations/{id}
  • Auth
    API key in header Authorization

Path parameters

idinteger required

Request body

allow_unsafe_instruction_tagsboolean

Keep script, iframe, style and other active tags in project instructions

contact_infostring email nullable
custom_interfaces_enabledboolean

Enable or disable custom interfaces for this organization

custom_scripts_enabledboolean nullable

Plugins

email_notification_settingsunknown
embed_domainsobject[] nullable

Supported domains

embed_enabledboolean

Enable or disable embed functionality for this organization

embed_settingsunknown
interface_settingsunknown
react_code_settingsunknown
titlestring nullable

Organization name

tokenstring nullable
token_expires_atstring date-time nullable

When the current invite link stops working; null works only while expiration is disabled

Response

allow_unsafe_instruction_tagsboolean required
created_atstring date-time required
custom_interfaces_enabledboolean nullable

Enable custom interfaces for this organization. When disabled, projects with use_custom_interface=True will not render custom interfaces anywhere in the product (label stream, embed, data manager, interfaces dashboard).

custom_scripts_enabledboolean required
default_role'OW' | 'AD' | 'MA' | 'RE' | 'AN' | 'DI' | 'NO' | 'VO'
  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
  • VO - View Only
email_notification_settingsobject required

Get email notification settings with default values for all notification types.

Returns a dictionary with the following structure: { 'notifications_allowed': { 'notification_type': bool }, 'notification_types': [ {'value': str, 'label': str} ] }

Excludes blocklisted notification types and ensures all valid types are included with proper defaults for any missing types.

When organization's email_notification_settings is null or empty, all notifications are shown as enabled (True) by default. When organization has some settings, unconfigured notifications default to False.

embed_domainsunknown
embed_enabledboolean nullable

Enable embed functionality for this organization

embed_settingsunknown
external_idstring nullable

External ID to uniquely identify this organization

idinteger required
interface_settingsunknown
react_code_settingsobject required
titlestring required
tokenstring required

Changes

  • 541fc59f868fRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

  • 62c0a4fd4e2bRevision changes
    • info

      added the new optional request property (media type: application/json)

    • info

      added the new optional request property (media type: application/x-www-form-urlencoded)

    • info

      added the new optional request property (media type: multipart/form-data)

    • info

      added the required property to the response with the status