Users
Update organization membership by external ID
Updates a user's membership details within an organization using your application's external identifier for the user. Use this endpoint to update roles and membership metadata without needing to store Scalekit's internal user ID.
patch/api/v1/memberships/organizations/{organization_id}/users:external/{external_id}
Path parameters
organization_idstring required
Unique identifier of the organization containing the membership. Must start with 'org_' and be 1-32 characters long.
external_idstring required
Your application's unique identifier for this user.
Request body
Example request
{
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"roles": [
{
"name": "admin"
}
]
}Response
Membership updated successfully. Returns the updated user object.
Example response
{
"user": {
"email": "user@example.com",
"external_id": "ext_12345a67b89c",
"id": "usr_1234abcd5678efgh",
"memberships": [
{
"display_name": "Acme Corporation",
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"name": "AcmeCorp",
"organization_id": "org_1234abcd5678efgh",
"permissions": [
"read_projects",
"write_tasks",
"manage_users"
],
"roles": [
{
"display_name": "Dev Team",
"id": "role_79643236410327240",
"name": "team_dev"
}
]
}
],
"metadata": {
"department": "engineering",
"location": "nyc-office"
},
"user_profile": {
"custom_attributes": {
"department": "engineering",
"security_clearance": "level2"
},
"email_verified": true,
"external_identities": [
{
"connection_id": "conn_1234abcd5678efgh",
"connection_type": "OAUTH",
"connection_user_id": "ext_user_12345",
"is_social": true
}
],
"family_name": "Doe",
"gender": "male",
"given_name": "John",
"groups": [
"admin",
"developer"
],
"id": "usr_profile_1234abcd5678efgh",
"locale": "en-US",
"metadata": {
"department": "engineering",
"employee_type": "full-time",
"idp_user_id": "12345"
},
"name": "John Michael Doe",
"phone_number": "+14155552671",
"phone_number_verified": true,
"picture": "https://example.com/avatar.jpg",
"preferred_username": "johndoe"
}
}
}