Skip to main content
POST
/
applications
/
{app}
/
groups
/
{group}
/
members
cURL
curl --request POST \
  --url https://api.rownd.io/applications/{app}/groups/{group}/members \
  --header 'Content-Type: application/json' \
  --header 'x-rownd-app-key: <api-key>' \
  --header 'x-rownd-app-secret: <api-key>' \
  --data '
{
  "user_id": "user_fbylaq38591cghym5pabupj2",
  "roles": [
    "owner",
    "editor"
  ],
  "state": "active"
}
'
{
  "user_id": "user_fbylaq38591cghym5pabupj2",
  "roles": [
    "owner",
    "editor"
  ],
  "id": "member_dnn5g4e3q6aptail2gr43kpj",
  "state": "active",
  "invited_by": "<string>",
  "added_by": "<string>",
  "profile": {
    "user_id": "user_a7b53gwdaml5jt7t71442nt7",
    "email": "[email protected]",
    "first_name": "Gary",
    "last_name": "Jackson"
  },
  "group_id": "group_ig42thhwf4cig25o7t9jtlyu"
}

Authorizations

​
x-rownd-app-key
string
header
required

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

​
x-rownd-app-secret
string
header
required

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

Path Parameters

​
app
string
required

Rownd application ID

​
group
string
required

Group ID

Body

application/json
​
user_id
string
required

The ID of a user to add as a group member. The user must belong to the Rownd application.

Example:

"user_fbylaq38591cghym5pabupj2"

​
roles
string[]
required

The roles that the member belongs. (The first member added or invited to a group will always be created with the 'owner' role along with any additional roles specified)

Example:
["owner", "editor"]
​
state
enum<string>

The state of the group member. A member that has been invited will not go into the active state until they accept the invitation.

Available options:
active,
invite_pending,
invite_rejected

Response

200 - application/json

Group member created successfully

​
user_id
string
required

The ID of a user to add as a group member. The user must belong to the Rownd application.

Example:

"user_fbylaq38591cghym5pabupj2"

​
roles
string[]
required

The roles that the member belongs. (The first member added or invited to a group will always be created with the 'owner' role along with any additional roles specified)

Example:
["owner", "editor"]
​
id
string

The group member ID

Example:

"member_dnn5g4e3q6aptail2gr43kpj"

​
state
enum<string>

The state of the group member. A member that has been invited will not go into the active state until they accept the invitation.

Available options:
active,
invite_pending,
invite_rejected
​
invited_by
string

The authenticated party that invited the user to the group

​
added_by
string

The authenticated party that added the user to the gruop

​
profile
object

User profile data

Example:
{
  "user_id": "user_a7b53gwdaml5jt7t71442nt7",
  "email": "[email protected]",
  "first_name": "Gary",
  "last_name": "Jackson"
}
​
group_id
string

The group ID

Example:

"group_ig42thhwf4cig25o7t9jtlyu"