Add a new group to the organization

Add a new group to the organization.

SecuritybearerAuth
Request
Request Body schema: application/json
name
required
string

Name of the group to create.

parentId
required
string

ID of the parent group. The new group will be placed under this parent.

description
string

Custom field.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

409

Conflict

500

Internal Server Error

post/groups
Request samples
application/json
{
  • "name": "testGroupName",
  • "parentId": "880e70d8-aaf8-18aa-7ab0-6533d8f1c360",
  • "description": "A new group being added."
}
Response samples
application/json
{
  • "id": "0c3c9820-3ee4-e98d-0987-c7333e722f72",
  • "createdDate": "2023-01-01T00:00:00Z",
  • "description": "this is a description",
  • "fullPath": "***Root\\\\Food%20Transportation%20INC",
  • "fullPathId": "750c5226-0f0a-402d-dcec-f83ccbb5373e\\\\0c3c9820-3ee4-e98d-0987-c7333e722f72",
  • "name": "Food Transportation INC",
  • "parentId": "750c5226-0f0a-402d-dcec-f83ccbb5373e",
  • "revision": 1,
  • "rootGroupId": "750c5226-0f0a-402d-dcec-f83ccbb5373e",
  • "updatedDate": "2023-02-01T00:00:00Z"
}