Classic APIs
ClassicGroupsApi
removeGroupRelationship

removeGroupRelationship

Removes an already existing group relationship

Parameters

NameTypeDescription
groupIdIdentifierThe id of the group to remove the relationship from.
groupRelationshipTypeGroupRelationshipTypeThe type of group relationship to remove.
relatedGroupIdIdentifierThe id of the group to remove.

Example

const { data: success } = await ClassicGroupsApi.removeGroupRelationship({
  groupId: 5850082,
  groupRelationshipType: "Allies",
  relatedGroupId: 3843784,
}); 

Endpoint

POST /v1/groups/{groupId}/relationships/{groupRelationshipType}/{relatedGroupId}