Skip to content

Delete a workspace member

Settings module

DELETE/workspace-members/{id}workspaceMembers.delete

A member of a workspace. Soft-deletes the workspace member: it moves to Trash and can be restored for its table's retention period.

  • Requires the capability org.workspaces.manage.
  • OAuth scopes: org.
  • Error statuses: 401, 404, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

workspaceMembers.delete: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the workspace member.

Response 204: no body.

Code samples

curl -X DELETE "$XOS_BASE_URL/workspace-members/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data } = await xos.workspaceMembers.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.workspace_members.delete("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos workspace-members delete 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f