Skip to content
API Reference
/
/
/
Add group

Add group

Request

Create a profile group.

  • Preconditions: the name must be non-empty, at most 100 characters, and not already used by a group in the team. A team is limited to 1000 groups.
  • Effect: creates the group. When the team authorizes access per group and the caller is not the owner, the caller is also granted access to the new group.
  • Completion: synchronous; data carries the new group id.
  • Retry: a duplicate name is rejected rather than reusing the existing group, so a retry after a successful-but-unseen call fails with a duplicate-name error — that is a signal the first call worked. Confirm with /envgroup/page.
Bodyapplication/json
groupNamestringrequired

Name of group

POST
/api/envgroup/create
curl -i -X POST \
  http://127.0.0.1:40000/api/envgroup/create \
  -H 'Content-Type: application/json' \
  -d '{
    "groupName": "Group-333"
  }'

Responses

Success. data is an object with the fields id and groupName.

Headers
any
Bodyapplication/json
codeintegerrequired

Return result code 0:Normal Other codes are exceptions.

msgstring or nullrequired

Error message

dataobjectrequired

The data returned by the operation

requestIdstringrequired

Operation Request ID

Response
{
  "code": 0,
  "msg": null,
  "data": {
    "id": "1673823102599682",
    "groupName": "example-name"
  },
  "requestId": "0d8b6f1c-9f4e-4d02-9d1a-7c3f5a1b2c3d"
}