Skip to main content

Overview

Invites users to a group.

Request

Authentication: Add authentication headers to the request. See Authentication

Method: POST

Rate limit: 100 requests/second

Endpoint: https://API domain/jim/groups/invite

Content-Type: application/json

Request parameters

ParameterData typeRequiredDescription
group_idstringYesGroup ID.
member_idsarrayYesUser ID list to invite to the group.

Request example

POST /jim/groups/invite HTTP/1.1
appkey: appkey
Authorization: xxxxxxxxxxxxxxxxxx
Content-Type: application/json

{
"group_id":"groupid1",
"member_ids":["userid1","userid2"]
}

Response example

{
"code":0,
"msg":"sucess"
}

Response codes

Response codesDescription