Update a group

PUT

groups

{group}

curl --request PUT \
  --url https://api.rownd.io/me/groups/{group} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Teammates",
  "admission_policy": "invite_only",
  "meta": {}
}'

{
  "group": {
    "id": "group_a3l1n2lsnb3q0xbul9enjnh7",
    "name": "My Teammates",
    "member_count": 0,
    "app_id": "327677849595019856",
    "admission_policy": "invite_only",
    "meta": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
    "created_by": "user_t6ftnnmw55pamuhfo9xvw0yl"
  },
  "member": {
    "id": "member_dnn5g4e3q6aptail2gr43kpj",
    "user_id": "user_fbylaq38591cghym5pabupj2",
    "roles": [
      "owner",
      "editor"
    ],
    "state": "active",
    "invited_by": "<string>",
    "added_by": "<string>",
    "profile": {
      "user_id": "user_a7b53gwdaml5jt7t71442nt7",
      "email": "gary@foo.com",
      "first_name": "Gary",
      "last_name": "Jackson"
    },
    "group_id": "group_ig42thhwf4cig25o7t9jtlyu"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token> where <token> is the user's Rownd JWT

Path Parameters

group

string

required

Group ID

Body

application/json

name

string

The group name

Example:

"My Teammates"

admission_policy

enum<string>

default:invite_only

Set whether the group be open for anyone to join or by invite only

Available options:

invite_only,

open

Example:

"invite_only"

Response

200 - application/json

Group created successfully

group

object

required

The group

member

object

required

The group member

member.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"

member.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"]

member.id

string

The group member ID

Example:

"member_dnn5g4e3q6aptail2gr43kpj"

member.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

member.invited_by

string

The authenticated party that invited the user to the group

member.added_by

string

The authenticated party that added the user to the gruop

member.profile

any

User profile data

member.group_id

string

The group ID

Example:

"group_ig42thhwf4cig25o7t9jtlyu"

Retrieve a group Delete a group

curl --request PUT \
  --url https://api.rownd.io/me/groups/{group} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "My Teammates",
  "admission_policy": "invite_only",
  "meta": {}
}'

{
  "group": {
    "id": "group_a3l1n2lsnb3q0xbul9enjnh7",
    "name": "My Teammates",
    "member_count": 0,
    "app_id": "327677849595019856",
    "admission_policy": "invite_only",
    "meta": {},
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": "user_t6ftnnmw55pamuhfo9xvw0yl",
    "created_by": "user_t6ftnnmw55pamuhfo9xvw0yl"
  },
  "member": {
    "id": "member_dnn5g4e3q6aptail2gr43kpj",
    "user_id": "user_fbylaq38591cghym5pabupj2",
    "roles": [
      "owner",
      "editor"
    ],
    "state": "active",
    "invited_by": "<string>",
    "added_by": "<string>",
    "profile": {
      "user_id": "user_a7b53gwdaml5jt7t71442nt7",
      "email": "gary@foo.com",
      "first_name": "Gary",
      "last_name": "Jackson"
    },
    "group_id": "group_ig42thhwf4cig25o7t9jtlyu"
  }
}

Get Started

App-Scoped Endpoints

User-Scoped Endpoints

Update a group

Authorizations

Path Parameters

Body

Response