Working with Group invitations

Learn how to invite, reinvite, and fetch invite lists using GraphQL.

Note
Only Group owners and community admins can send a group invitation.

You can send invitations to the following:

• Community members with their user ID
• External users with their email address.

Group owners can send 50 invitations in an hour and up to 100 invitations in a day. To change these default configuration values, you must open a support ticket.

Send invitations

The following are the mutation parameters for the sendInvite mutation.

Parameter	Sub-parameter	Description	Required
nodeId		The group node ID for which you want to send the invitation	Yes
createInput		The input object with the required fields to send the invitation	Yes
	invitees	A list of users to add as invitees. Supported fields: - userIds (community user ID) - externalInvitees (external email address)	Yes
	role	Membership role. Supported values: - Member - Curator - Inviter - Owner	Yes
	body	Optional message for the invitation	No

The following is an example GraphQL call to send a group invitation.

mutation {
  sendInvite(
    nodeId: "grouphub:gh1"
    createInput: {
      invitees: {
        userIds: [{ id: "user:8" }]
        externalInvitees: ["testuser@gmail.com"]
      }
      role: { name: "Member" }
      body: "<p>Join the group to be a part of greater community needs.</p>"
    }
  ) {
    result
  }
}

Resend invitations

Use the resendInvite mutation to resend the invitation to the community member or external user.

The following are the parameters for the mutation.

Parameter	Description	Required
nodeId	The group node ID for which you want to resend the invitation	Yes
user	The user to whom the invitation is being sent	Yes

Community Member Example

The following is a GraphQL example mutation to resend an invitation for a community member.

mutation {
  resendInvite(nodeId: "grouphub:docs-group-2", user: { id: "user:1" }) {
    result
  }
}

External User Example

The following is a GraphQL example mutation to resend an invitation to an external user.

mutation {
  resendInvite(
    nodeId: "grouphub:docs-group-5"
    externalUserEmail: "testuser55@gmail.com"
  ) {
    result
  }
}

Fetch the invitation list

The following is a GraphQL example query used to fetch the group invitation list.

{
  groupHub(id: "grouphub:docs-group") {
    membershipInvites {
      edges {
        node {
          externalUserEmail
          inviteDate
          role {
            id
          }
          user {
            id
          }
        }
      }
    }
  }
}

The following is the GraphQL example response:

{
  "data": {
    "groupHub": {
      "membershipInvites": {
        "edges": [
          {
            "node": {
              "externalUserEmail": "javidhus@gmail.com",
              "inviteDate": "2025-05-13T22:54:19.250-07:00",
              "role": {
                "id": "role:g:docs-group:Curator:memberships"
              },
              "user": null
            }
          },
          {
            "node": {
              "externalUserEmail": "javid.aeronautics@gmail.com",
              "inviteDate": "2025-05-13T22:05:03.477-07:00",
              "role": {
                "id": "role:g:docs-group:Member:memberships"
              },
              "user": null
            }
          },
          {
            "node": {
              "externalUserEmail": null,
              "inviteDate": "2025-05-13T22:04:28.438-07:00",
              "role": {
                "id": "role:g:docs-group:Member:memberships"
              },
              "user": {
                "id": "user:171"
              }
            }
          }
        ]
      }
    }
  }
}