Skip to content

Remove a member

DELETE
/v1/members/{memberId}
curl --request DELETE \
--url https://api.overwatch.weareheavy.dev/v1/members/example \
--header 'Authorization: Bearer <token>'

Remove a member from the organization. Their per-site grants are removed with them. The last owner is protected. Session-only, owner/admin.

memberId
required
string

The member’s id (from GET /v1/members).

The member was removed.

Media typeapplication/json
object
removed
required
boolean
Example
{
"removed": true
}

The auth layer rejected the removal (e.g. last owner).

Media typeapplication/json
object
error
required

A human-readable error message.

string
Examplegenerated
{
"error": "example"
}

Missing or invalid credentials.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
"error": "invalid api key"
}

A dashboard session is required (API-key callers are rejected), or the session’s role does not allow this action.

Media typeapplication/json
object
error
required

A human-readable error message.

string
Example
{
"error": "a dashboard session is required"
}