Group Invites

Invite internal and external users to join a group.

Resource

1/chatter/groups/group/groupId/invite

Available version

39.0

Requires Chatter

Yes

HTTP methods

POST

Request body for POST

Root XML tag

<inviteCollection>

JSON example

1{
2   "invitees" : {
3      "emails": [
4         "emailaddress1@internaldomain.com",
5         "emailaddress2@externaldomain.com"
6      ]
7   },
8   "message" : "Join this group to participate in the discussion about your favorite feature."
9}

Properties

Name	Type	Description	Required or Optional	Available Version
`invitees`	String[]	List of email addresses to send the invitation to.	Required	39.0
`message`	String	Message to include in the invitation.	Optional	39.0

Response body for POST

Invite Collection

Chatter REST API Developer Guide

Group Invites