Remove a team member from team by e-mail

Removes a member from the team, or cancels a pending invitation, by their email address. This action cannot be undone.

Removing a user with the admin role is not permitted via the API.

DELETE https://betterstack.com/api/v2/team-members

Query parameters

team_name

string

Required if using a global API token to specify the team.

required string

The email address of the team member to remove or invitation to cancel. Can be passed as a query parameter or in the request body.

Headers

Authorization

required string

Bearer $TOKEN

204

The team member or invitation was successfully removed.

404

No team member or invitation with the specified email was found.

Response body

{
  "errors": "Team member with email \"nonexistent@example.com\" not found"
}

422

The email field is missing or blank.

Response body

{
  "errors": "Email is required"
}

403

Removing an admin is forbidden.

Response body

{
  "errors": "Removing admins is not allowed via API"
}

Example

Copied!

curl --request DELETE \
  --url "https://betterstack.com/api/v2/team-members?email=bob@example.com" \
  --header "Authorization: Bearer $TOKEN"

Remove a team member from team by ID