Classic APIs
ClassicGroupsApi
requestGroupRelationship

requestGroupRelationship

Sends a group relationship request to a group.

Parameters

NameTypeDescription
groupIdIdentifierThe id of the group to send a request for.
groupRelationshipTypeGroupRelationshipTypeThe type of group relationship to request.
relatedGroupIdIdentifierThe id of the group to request a relationship with.

Example

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

Endpoint

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