API
group.invites.createInvite
API
group.invites.createInvite
Creates a group invite. Can be shared with other identities to let them join this group.
POST https://group.api.rivet.gg/v1/groups/{group_id}/invites
curl -X POST -d '@body.json' 'https://group.api.rivet.gg/v1/groups/{group_id}/invites'
Authorizations
Authorization[header]required
string
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
group_idrequired
string
Body
ttl
number
How long until the group invite expires (in milliseconds).
use_count
number
How many times the group invite can be used.
Response
coderequired
string
The code that will be passed to rivet.api.group#ConsumeInvite to join a group.
curl -X POST -d '@body.json' 'https://group.api.rivet.gg/v1/groups/{group_id}/invites'