Skip to main content
DELETE
Remove a team member

Authorizations

Authorization
string
header
required

OAuth 2.1 authorization code + PKCE (S256). Tokens are tenant-bound (company_id) and scoped. Discover endpoints via /.well-known/oauth-authorization-server.

Body

application/json

Remove a member from the company's team (resolved by email). companyId is injected from the token tenant and must NOT be supplied. Required (validated in the use-case): memberEmail. Source: lib/api/team/delete-member.usecase.ts + remove_team_member call.body. The route zod (DeleteMemberInput) is .passthrough().

memberEmail
string<email>
required

Email of the member to remove.

propagateToAgency
boolean

Propagate the removal across agency companies (default false).

Response

Remove-member success: confirmation message and the agency-propagation summary (null when not propagated).

data
object
required

Delete-member result. Source: DeleteMemberResult (lib/api/team/delete-member.usecase.ts). propagation is null unless propagateToAgency was set and propagation succeeded.