Remove a workspace member
curl --request DELETE \
--url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members/{memberId} \
--header 'X-API-Key: <api-key>'{
"success": true,
"data": {
"memberId": "<string>",
"removed": true,
"projectMembershipsRemoved": 123,
"transferredProjects": 123,
"transferredAgents": 123
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}Remove a workspace member
Remove a workspace member or revoke an invitation, with optional transfer of their projects and agents.
DELETE
/
api
/
public
/
v1
/
workspaces
/
{workspaceId}
/
members
/
{memberId}
Remove a workspace member
curl --request DELETE \
--url https://{platformHost}/api/public/v1/workspaces/{workspaceId}/members/{memberId} \
--header 'X-API-Key: <api-key>'{
"success": true,
"data": {
"memberId": "<string>",
"removed": true,
"projectMembershipsRemoved": 123,
"transferredProjects": 123,
"transferredAgents": 123
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}{
"success": false,
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "<string>",
"messages": [
"<string>"
],
"retryable": true,
"details": {}
}
}transferOwnershipTo to the memberId of an eligible active member. Otherwise the request fails with 409 MEMBER_OWNS_RESOURCES.
The response reports how many project memberships the API removed, and how many projects and agents it transferred. The request needs the workspace.members.write scope.Authorizations
platformApiKeybearerPlatformKey
Path Parameters
Query Parameters
Was this page helpful?