PUT
/
applications
/
{app}
/
groups
/
{group}
/
invites
/
{invite}

Authorizations

​
x-rownd-app-key
string
headerrequired

The publishable key of your application credentials. (more details)

​
x-rownd-app-secret
string
headerrequired

The private secret of your application credentials. (more details)

Path Parameters

​
app
string
required

Rownd application ID

​
group
string
required

Group ID

​
invite
string
required

Group Invite ID

Body

application/json
​
roles
string[]
required

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)

​
email
string

The email of a Rownd user in the specified application. This property is mutually exclusive with user_id and email

​
phone
string

The phone number of a Rownd user in the specified application. This property is mutually exclusive with user_id and email

​
user_id
string

The ID of a Rownd user in the specified application. This property is mutually exclusive with phone and email

​
redirect_url
string

The relative or absolute path location to which a user will be directed after accepting the invite

​
app_variant_id
string

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

200 - application/json
​
roles
string[]
required

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)

​
id
string

The group invite ID

​
group_id
string

The group ID

​
state
enum<string>

The state of the invite

Available options:
pending,
accepted,
rejected
​
email
string

The email of a Rownd user in the specified application. This property is mutually exclusive with user_id and email

​
phone
string

The phone number of a Rownd user in the specified application. This property is mutually exclusive with user_id and email

​
user_id
string

The ID of a Rownd user in the specified application. This property is mutually exclusive with phone and email

​
user_lookup_value
string

The email or phone number specified during creation

​
redirect_url
string

The relative or absolute path location to which a user will be directed after accepting the invite

​
app_variant_id
string

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)

​
created_at
string

The ISO 8601 date-time that the resource was created

​
created_by
string

The ID of the user that created the resource

​
accepted_by
string

The ID of the user that accepted the invite

​
ensured_user_id
string

The ID of the user ensured by the provided user_id or user_lookup_value

Retrieve a group inviteDelete a group invite