Create group

POST

/api/groups/create

curl --request POST \
  --url http://localhost:3001/api/groups/create \
  --header 'Authorization: <Authorization>' \
  --header 'Content-Type: application/json' \
  --data '{ "avatar_chunk_id": 1, "avatar_key": "example", "description": "example", "is_public": true, "members": [ "example" ], "name": "example" }'

• Local development
• Production

Create a new group chat with an initial member list.

Authorizations

• BearerAuth

Request Body^required

Group creation request

Media typeapplication/json

object

avatar_chunk_id

MeshStorage chunk ID for avatar

integer

avatar_key

Base64-encoded encryption key

string

description

Group description

string

is_public

Public or private group

boolean

members

Initial member addresses

Array<string>

name

Group name

string

Example^generated

{
  "avatar_chunk_id": 1,
  "avatar_key": "example",
  "description": "example",
  "is_public": true,
  "members": [
    "example"
  ],
  "name": "example"
}

Responses

200

OK

Media typeapplication/json

object

group

object

avatar_chunk_id

integer

avatar_key

Array<integer>

avatar_url

Generated MeshStorage download URL

string

created_at

string

description

string

id

string

is_muted

Whether user muted this group

boolean

is_public

boolean

member_count

integer

members

All member addresses

Array<string>

name

string

owner_address

string

unread_count

Number of unread messages for requesting user

integer

updated_at

string

user_role

Role of requesting user: “owner”, “admin”, “member”

string

message

string

success

boolean

Example^generated

{
  "group": {
    "avatar_chunk_id": 1,
    "avatar_key": [
      1
    ],
    "avatar_url": "example",
    "created_at": "example",
    "description": "example",
    "id": "example",
    "is_muted": true,
    "is_public": true,
    "member_count": 1,
    "members": [
      "example"
    ],
    "name": "example",
    "owner_address": "example",
    "unread_count": 1,
    "updated_at": "example",
    "user_role": "example"
  },
  "message": "example",
  "success": true
}

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
}

409

Conflict

Media typeapplication/json

object

error

string

success

boolean

Example^generated

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

500

Internal Server Error

Media typeapplication/json

object

error

string

success

boolean

Example^generated

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