Invite to Group


A group administrator can invite users to join their group using the Invite to Group operation. This creates a new user invitation, which the users accept or decline. The role of the user and the invitation expiration date can be set in the invitation. A notification is created for the user indicating that they were invited to join the group. Available only to authenticated users.

Request Parameters

[Common Parameters]

For a complete listing, see Common parameters.


A comma separated list of usernames to be invited to the group. If a user is already a member of the group or an invitation has already been sent, the call still returns a success.

Example: users=regularusername1,regularusername2


Allows administrators to set the user's role in the group. Roles are:

  • group_member: Ability to view and share items with group.
  • group_admin: In addition to viewing and sharing items, the group_admin has the same capabilities as the group owner—invite users to the group, accept or decline group applications, delete content, and remove users.

Expiration date on the invitation can be set for one day, three days, one week, or two weeks, in minutes.

Example: expiration=1440

Example Usage

URL for Invite Users to a Group
users=mjohnson, swilson, rfields

JSON Response Syntax

  "success": true | false,
  "groupId": "<group id>"

JSON Response Example

  "success": true,
  "groupId": "2ecb37a8c8fb4051af9c086c25503bb0"