Invite a user to a group

post/v2/groups/{groupId}/invitations

Path parameters

groupIdinteger required

isSecureboolean

recipientUserIdinteger required

The user to invite.

roleIdsinteger[] nullable

Group role ids to grant when the invitation is accepted.

Success

idstring required

The invitation id. Stringified because it can exceed the 2^53-1 JSON number limit.

groupIdinteger required

The group the invitation is for.

recipientUserIdinteger required

The invited user.

senderUserIdinteger required

The user who sent the invitation.

status'Open' | 'Accepted' | 'Declined' | 'Deleted' required

Status of a group invitation, serialized as its name.

roleIdsinteger[] required

Every group role id attached to the invitation.

updatedAtstring date-time required

When the invitation was last updated (UTC).

Changed in 1 of the 23 revisions of this API.1