Organizations

✨ Update organization member/role

<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 membership or role for a specific user ID.

User Rotation Best Practices for API Usage

To maintain compliance with our licensing terms and ensure optimal performance of HumanSignal's APIs, please consider the following guidelines when managing user assignments:

  • Maintain a 7-Day Minimum Assignment: Once a licensed seat is assigned to a user, maintain that assignment for at least seven consecutive days before rotating it to another user.

  • Automate, Monitor, and Log Rotations: Implement automated scheduling and logging mechanisms to track the timing of user rotations. This helps ensure that rotations adhere to the seven-day minimum period.

  • Adhere to API Update Frequency and Wait Periods: When updating user assignments via our APIs, follow the recommended frequency and wait period guidelines provided in the HumanSignal API documentation. Avoid sending rapid, successive requests that might overload the endpoint. Instead, incorporate appropriate delays between calls as specified in the documentation.

  • Avoid Overloading the API Endpoint: Design your integration to batch or schedule updates where possible, and implement backoff strategies if the API indicates rate limiting. This helps prevent service disruptions and ensures a smooth operation.

patch/api/organizations/{id}/memberships

Path parameters

idinteger required

A unique integer value identifying this organization.

Request body

role'OW' | 'AD' | 'MA' | 'RE' | 'AN' | 'DI' | 'NO'
  • OW - Owner
  • AD - Administrator
  • MA - Manager
  • RE - Reviewer
  • AN - Annotator
  • DI - Deactivated
  • NO - Not Activated
user_idinteger

Member

Response

concurrencystring required
idinteger required
organizationinteger required

Organization ID

rolestring required
role_sourcestring required
user_typestring required

Changes