Skip to content
HeyX API

Add and Remove Team Members

Use POST /public-api/publicapi.v1.Team/AddTeamMember or POST /public-api/publicapi.v1.Team/RemoveTeamMember with the same body:

Required scopes are team_member:add and team_member:remove, respectively.

{ "teamId": "<team-id>", "memberId": "<member-id>" }

Both IDs must belong to the connected workspace. memberId is the membership ID from Get/List/SearchMembers, not the account ID used for problem assignment. The creator’s team-management authorization and exact API scope are enforced.

Each response contains success. Adding affects only this team; removing does not remove the workspace member, their roles, or other memberships. Team changes can change which Customer Views match the member, but these operations do not edit View definitions or customer ACLs. Inspect state after an uncertain response instead of assuming a mutation was cancelled. Both are treated as non-idempotent public mutations.

Contract

Generated Reference
POST /public-api/publicapi.v1.Team/AddTeamMember

Adds one workspace member without replacing other teams or roles.

Request AddTeamMemberRequest
Response AddTeamMemberResponse

AddTeamMemberRequest

Field Type
team_id string
member_id string

AddTeamMemberResponse

Field Type
success bool

Contract

Generated Reference
POST /public-api/publicapi.v1.Team/RemoveTeamMember

Removes one team membership, not the workspace member or their roles.

Request RemoveTeamMemberRequest
Response RemoveTeamMemberResponse

RemoveTeamMemberRequest

Field Type
team_id string
member_id string

RemoveTeamMemberResponse

Field Type
success bool
HeyX API