[Go to site: main page, start]
API ReferenceOrganizations

✨ Update organization

<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.

Authentication

AuthorizationToken
The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>

Path parameters

idintegerRequired

Request

This endpoint expects an object.
contact_infostring or nullOptionalformat: "email"<=254 characters
created_byinteger or nullOptional
custom_interfaces_enabledbooleanOptional
Enable or disable custom interfaces for this organization
custom_scripts_enabledboolean or nullOptional
Plugins
email_notification_settingsany or nullOptional
Email Notification Settings
embed_domainslist of maps from strings to strings or nullOptional
Supported domains
embed_enabledbooleanOptional
Enable or disable embed functionality for this organization
embed_settingsany or nullOptional
Public Verification Key and Public Verification Algorithms configuration
interface_settingsany or nullOptional

Security settings for custom interfaces: CSP allowlists, script origins, iframe permissions

react_code_settingsany or nullOptional
ReactCode settings
titlestring or nullOptional>=1 character
Organization name
tokenstring or nullOptional<=256 characters

Response

billingobject
created_atdatetimeRead-only
custom_scripts_enabledbooleanRead-only
email_notification_settingsmap from strings to anyRead-only

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.

idintegerRead-only
react_code_settingsmap from strings to anyRead-only
titlestringRead-only
tokenstringRead-only
custom_interfaces_enabledboolean or nullOptional

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).

default_roleenumOptional

Default membership role for invited users

  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
  • VO - View Only
embed_domainsany or nullOptional

List of objects: {“domain”: “example.com”}. Used for CSP header on /embed routes.

embed_enabledboolean or nullOptional
Enable embed functionality for this organization
embed_settingsany or nullOptional
Embed settings for this organization
external_idstring or nullOptional
External ID to uniquely identify this organization
interface_settingsany or nullOptional

Security settings for custom interfaces: CSP allowlists, script origins, iframe permissions.

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error