Rivet

invites.createInvite

Description

Creates a group invite. Can be shared with other identities to let them join this group.

Code Examples

Request

POST
https://api.rivet.gg/group/groups/{group_id}/invites
# Write the request body to body.json before running
curl -X POST -d '@body.json' 'https://api.rivet.gg/group/groups/{group_id}/invites'

Request Parameters

group_id

Path parameter, required

Request 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 Body

code

string (required)

The code that will be passed to rivet.api.group#ConsumeInvite to join a group.

Was this page helpful?

Edit Page

On this page

Rivet

Open-source multiplayer infrastructure. Easy, flexible, and affordable.

DiscordTwitterGitHubYouTubeLinkedIn
Legal
This website is not sponsored by or affiliated with Unity Technologies or its affiliates. Unity Trademark(s) are trademark(s) or registered trademark(s) of Unity Technologies or its affiliates in the U.S. and elsewhere. | This website is not sponsored by, affiliated with, or endorsed by Epic Games, Inc. or its affiliates. 'Unreal Engine' is a trademark or registered trademark of Epic Games, Inc. in the U.S. and elsewhere. | The HTML5 Logo by the World Wide Web Consortium (W3C), used under a Creative Commons Attribution 3.0 License. Source | The Godot Engine Logo by the Andrea Calabró, used under a Creative Commons Attribution 4.0 International License. Source | Docker and the Docker logo are trademarks or registered trademarks of Docker, Inc. in the United States and/or other countries. Docker, Inc. and other parties may also have trademark rights in other terms used herein.

© 2024 Rivet Gaming, Inc. All rights reserved.