Skip to navigation

Bulk Remove Workspace Members

Remove multiple members from a workspace and cancel multiple pending invites, in one request. This is the only endpoint that cancels an invite. Remove Workspace Member removes active members only.

Removing a member revokes their access to the whole workspace and frees their seat. Cancelling an invite stops it from being accepted. Both are broader than Revoke Site Access, which removes a person from one site and leaves their workspace membership in place.

This endpoint shares its path with Bulk Update Workspace Member Roles. POST changes roles. DELETE removes members and cancels invites.

Partial success

This endpoint answers 200 once it has processed the batch, even when some or all of the items failed. Individual ids can fail while others succeed, so read summary and results instead of relying on the status code. Match each result back to your input by id, not by position. Ids are deduplicated before processing, so results can be shorter than the request.

A 4xx response means the whole request was refused before anything was removed. It carries no per-item report.

A failed item is left unchanged, with one exception. If an item fails with internal_error, the member or invite may already have been removed. Check the list of workspace members before you retry it.

Enterprise Only
This endpoint requires an Enterprise workspace.

Required scope | workspace_members:write

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

workspace_idstringRequiredformat: "objectid"
Unique identifier for a Workspace

Request

Requires at least one of memberIds or inviteIds. Their combined length is capped at 100. IDs must be lowercase; a mixed-case ID fails validation with a 400.

memberIdslist of stringsOptional
IDs of active Members to remove
inviteIdslist of stringsOptional
IDs of pending invites to cancel

Response

Request was processed. Check results for per-item outcomes.

summaryobject
Counts of removed and failed items
resultslist of objects

Result for each id. Match results to the request by id, not by position.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error