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": {}
  }
}

DELETE

api

public

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": {}
  }
}

Use this endpoint to revoke a pending or expired invitation, or to remove an active member from the workspace and its projects. If the member owns projects or agents, set 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

X-API-Key

string

header

required

Platform key, for example abl_ws_….

Path Parameters

workspaceId

string

required

Minimum string length: 1

memberId

string

required

Minimum string length: 1

Query Parameters

transferOwnershipTo

string

The memberId of an eligible active member who receives the removed member’s projects and agents.

Response

Success

success

enum<boolean>

required

Available options:

true

data

object

required

Show child attributes

APIs

SDKs

Remove a workspace member

Authorizations

Path Parameters

Query Parameters

Response