curl --request POST \
--url https://api.rownd.io/applications/{app}/groups/{group}/invites \
--header 'Content-Type: application/json' \
--header 'x-rownd-app-key: <api-key>' \
--header 'x-rownd-app-secret: <api-key>' \
--data '
{
"user_id": "user_ofr5pgvof4w6o94hgjg0urjy",
"roles": [
"admin"
],
"redirect_url": "/somewhere/on/my/site#"
}
'{
"link": "<string>",
"invitation": {
"roles": [
"editor"
],
"id": "c92kd7td7z4myhu7z5y637cp",
"group_id": "group_zjca79svvbqfeilwr8httcal",
"state": "pending",
"email": "randy@foo.com",
"phone": 19199993333,
"user_id": "user_mni5316glfgwtgljboxrv2it",
"user_lookup_value": "randy@foo.com",
"redirect_url": "/somewhere/on/my/site#",
"app_variant_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
"accepted_by": "user_vgzrk03xpenj6td8vwi9crh4",
"ensured_user_id": "<string>"
}
}Create a group invite
Platform API for creating a group invite
curl --request POST \
--url https://api.rownd.io/applications/{app}/groups/{group}/invites \
--header 'Content-Type: application/json' \
--header 'x-rownd-app-key: <api-key>' \
--header 'x-rownd-app-secret: <api-key>' \
--data '
{
"user_id": "user_ofr5pgvof4w6o94hgjg0urjy",
"roles": [
"admin"
],
"redirect_url": "/somewhere/on/my/site#"
}
'{
"link": "<string>",
"invitation": {
"roles": [
"editor"
],
"id": "c92kd7td7z4myhu7z5y637cp",
"group_id": "group_zjca79svvbqfeilwr8httcal",
"state": "pending",
"email": "randy@foo.com",
"phone": 19199993333,
"user_id": "user_mni5316glfgwtgljboxrv2it",
"user_lookup_value": "randy@foo.com",
"redirect_url": "/somewhere/on/my/site#",
"app_variant_id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"created_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
"accepted_by": "user_vgzrk03xpenj6td8vwi9crh4",
"ensured_user_id": "<string>"
}
}Authorizations
The publishable key of your application credentials. (more details)
The private secret of your application credentials. (more details)
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)
["editor"]
The email of a Rownd user in the specified application. This property is mutually exclusive
with user_id and email
"randy@foo.com"
The phone number of a Rownd user in the specified application. This property is mutually
exclusive with user_id and email
19199993333
The ID of a Rownd user in the specified application. This property is mutually exclusive with
phone and email
"user_mni5316glfgwtgljboxrv2it"
The relative or absolute path location to which a user will be directed after accepting the invite
"/somewhere/on/my/site#"
Response
Group invite created successfully