✨ Update organization member/role | API Reference

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

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.

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

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:

curl https://label-studio-host/api/projects -H “Authorization: Token [your-token]”

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

A unique integer value identifying this organization.

Request

This endpoint expects an object.

roleenumOptional

Organization role

OW - Owner
AD - Administrator
MA - Manager
RE - Reviewer
AN - Annotator
DI - Deactivated
NO - Not Activated

user_idintegerOptional

Member

Response

concurrencystringRead-only

contributed_to_projectslist of objects or nullRead-only

created_projectslist of objects or nullRead-only

idintegerRead-only

organizationinteger

Organization ID

rolestringRead-only

role_sourcestringRead-only

tagslist of objectsRead-only

userobject

A ModelSerializer that takes additional arguments for "fields", "omit" and "expand" in order to control which fields are displayed, and whether to replace simple values with complex, nested serializations

user_typestringRead-only

This endpoint is not available in Label Studio Community Edition. Learn more about Label Studio Enterprise

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.

$	curl -X PATCH http://localhost:8000/api/organizations/1/memberships \
>	-H "Authorization: Token <api_key>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"concurrency": "3",
3	"contributed_to_projects": [
4	{
5	"id": 101,
6	"title": "Image Annotation Project"
7	}
8	],
9	"created_projects": [
10	{
11	"id": 55,
12	"title": "Text Classification Setup"
13	}
14	],
15	"id": 42,
16	"organization": 1,
17	"role": "MA",
18	"role_source": "manual_assignment",
19	"tags": [
20	{
21	"id": 7,
22	"label": "team-lead"
23	}
24	],
25	"user": {
26	"avatar": "https://example.com/avatars/user42.png",
27	"id": 42,
28	"initials": "JD",
29	"last_activity": "2024-06-10T16:45:00Z",
30	"lse_fields": {
31	"email_notification_settings": "daily_summary",
32	"invite_expired": "false",
33	"invite_expired_at": "2024-12-31T23:59:59Z",
34	"invite_activated": true,
35	"invited_at": "2023-08-01T09:00:00Z",
36	"invited_by": 3,
37	"onboarding_state": "complete",
38	"social_auth_finished": true,
39	"trial_company": "Acme Corp",
40	"trial_experience_labeling": "positive",
41	"trial_license_enterprise": true,
42	"trial_models_in_production": "2",
43	"trial_role": "annotator_team_manager"
44	},
45	"pause": "none",
46	"username": "janedoe",
47	"contributed_to_projects": [
48	{
49	"id": 101,
50	"title": "Image Annotation Project"
51	}
52	],
53	"created_projects": [
54	{
55	"id": 55,
56	"title": "Text Classification Setup"
57	}
58	],
59	"active_organization": 1,
60	"allow_newsletters": true,
61	"custom_hotkeys": null,
62	"date_joined": "2023-08-10T14:22:00Z",
63	"email": "jane.doe@example.com",
64	"first_name": "Jane",
65	"last_name": "Doe",
66	"phone": "+1-555-123-4567"
67	},
68	"user_type": "member"
69	}