API Reference / Memberships
Remove a member from a workspace
Removes a membership, revoking the member's access to the workspace.
/ accounts. v1. Accounts/ DeleteMembershipRequest body
application/jsonRequired
Request to remove a member from the caller's workspace. The owner or an administrator can remove a member or a pending invitation. Only the owner can remove an administrator, and nobody can remove the owner. The member loses access immediately and their API keys in the workspace are revoked.
membershipId?stringOpaque 16-byte identifier of the membership to remove, base64-encoded in JSON.
Format"byte" base64
Response body
application/json
Success
No fields.
application/json
The request was malformed, such as a missing required field or an unparseable cursor. The request cannot be carried out in the current system state.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request lacks a valid API key in the Authorization header.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The API key is not allowed to perform this action on this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The requested resource does not exist in this workspace.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
The request was rate limited. Slow down and retry later.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
application/json
An internal server error occurred.
codestringThe Connect error code, such as "not_found".
details?array<object>Optional machine-readable error details.
messagestringA human-readable description of the error.
curl -X POST "https://api.goldmine.to/accounts.v1.Accounts/DeleteMembership" \
-H "Authorization: Bearer $CSTRADER_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"membershipId": "ICEiIyQlJicoKSorLC0uLw=="
}'const res = await fetch("https://api.goldmine.to/accounts.v1.Accounts/DeleteMembership", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CSTRADER_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"membershipId": "ICEiIyQlJicoKSorLC0uLw=="
}),
});
const data = await res.json();body := strings.NewReader(`{
"membershipId": "ICEiIyQlJicoKSorLC0uLw=="
}`)
req, err := http.NewRequestWithContext(ctx, http.MethodPost, "https://api.goldmine.to/accounts.v1.Accounts/DeleteMembership", body)
if err != nil {
return err
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("CSTRADER_API_KEY"))
req.Header.Set("Content-Type", "application/json")
res, err := http.DefaultClient.Do(req)import os, requests
res = requests.post(
"https://api.goldmine.to/accounts.v1.Accounts/DeleteMembership",
headers={"Authorization": f"Bearer {os.environ['CSTRADER_API_KEY']}"},
json={
"membershipId": "ICEiIyQlJicoKSorLC0uLw=="
},
)
data = res.json(){}{
"code": "failed_precondition",
"message": "The request cannot be carried out in the current system state."
}{
"code": "unauthenticated",
"message": "The request lacks a valid API key in the Authorization header."
}{
"code": "permission_denied",
"message": "The API key is not allowed to perform this action on this workspace."
}{
"code": "not_found",
"message": "The requested resource does not exist in this workspace."
}{
"code": "resource_exhausted",
"message": "The request was rate limited. Slow down and retry later."
}{
"code": "internal",
"message": "An internal server error occurred."
}