Update a group

PUT

/api/groups/{groupId}

curl --request PUT \
  --url http://localhost:3001/api/groups/example \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "avatar_chunk_id": 1, "avatar_key": "example", "description": "example", "group_id": "example", "name": "example" }'

• Local development
• Production

Update group information (name, description, avatar, etc.)

Authorizations

• BearerAuth

Parameters

Path Parameters

groupId

required

string

Group ID

Request Body^required

Group update request

Media typeapplication/json

object

avatar_chunk_id

integer

avatar_key

string

description

string

group_id

string

name

string

Example^generated

{
  "avatar_chunk_id": 1,
  "avatar_key": "example",
  "description": "example",
  "group_id": "example",
  "name": "example"
}

Responses

200

OK

Media typeapplication/json

object

key

additional properties

any

Example^generated

{}

400

Bad Request

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

401

Unauthorized

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

403

Forbidden

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}

404

Not Found

Media typeapplication/json

object

error

string

success

boolean

Example^generated

{
  "error": "example",
  "success": true
}