Create a group invite
User-facing API for creating a group invite. An invite can be created for a user by providing
their user_id
, email
, or phone
. Once accepted, the user will be added as a member within
the group and be assigned the roles specified in the invite.
Authorizations
Bearer authentication header of the form Bearer <token>
where <token>
is the user's Rownd JWT
Path Parameters
Group ID
Body
The roles into which a group member will be added upon invite acceptance (The first member invited to a group will always be created with the 'owner' role along with any additional roles specified)
The email of a Rownd user in the specified application. This property is mutually exclusive
with user_id
and email
The phone number of a Rownd user in the specified application. This property is mutually
exclusive with user_id
and email
The ID of a Rownd user in the specified application. This property is mutually exclusive with
phone
and email
The relative or absolute path location to which a user will be directed after accepting the invite
The ID of an application variant for which this invite should be created. When a user accepts this invite, they will be added to the group as a member and signed into this application variant. (Learn about variants here)
Response
The invitation link