Skip to main content

CreateGroupInvite

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

Path Parameters
  • group_id string required

    Possible values: Value must match regular expression ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

    A universally unique identifier.

Request Body
  • ttl int64

    How long until the group invite expires (in milliseconds).

  • use_count int64

    How many times the group invite can be used.

Responses

CreateGroupInvite 200 response

Schema
  • code string required

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