Create Group

POST

https://api.devrev.ai/groups.create

POST

/groups.create

1 curl -X POST https://api.devrev.ai/groups.create \
2      -H "Authorization: Bearer <token>" \
3      -H "Content-Type: application/json" \
4      -d '{
5   "description": "foo",
6   "name": "foo"
7 }'

Try it

201groupsCreateExample

1 {
2   "group": {
3     "id": "foo",
4     "is_default": true,
5     "created_by": {
6       "display_id": "foo",
7       "id": "foo",
8       "display_name": "foo",
9       "display_picture": {
10         "display_id": "foo",
11         "id": "foo",
12         "file": {
13           "type": "foo",
14           "name": "foo",
15           "size": 42
16         }
17       },
18       "email": "foo",
19       "full_name": "foo",
20       "state": "active"
21     },
22     "created_date": "2023-01-01T12:00:00.000Z",
23     "description": "foo",
24     "display_id": "foo",
25     "member_type": "dev_user",
26     "modified_by": {
27       "display_id": "foo",
28       "id": "foo",
29       "display_name": "foo",
30       "display_picture": {
31         "display_id": "foo",
32         "id": "foo",
33         "file": {
34           "type": "foo",
35           "name": "foo",
36           "size": 42
37         }
38       },
39       "email": "foo",
40       "full_name": "foo",
41       "state": "active"
42     },
43     "modified_date": "2023-01-01T12:00:00.000Z",
44     "name": "foo",
45     "owner": {
46       "display_id": "foo",
47       "id": "foo",
48       "display_name": "foo",
49       "display_picture": {
50         "display_id": "foo",
51         "id": "foo",
52         "file": {
53           "type": "foo",
54           "name": "foo",
55           "size": 42
56         }
57       },
58       "email": "foo",
59       "full_name": "foo",
60       "state": "active"
61     },
62     "sync_metadata": {
63       "external_reference": "foo",
64       "last_sync_in": {
65         "status": "failed",
66         "sync_date": "2023-01-01T12:00:00.000Z",
67         "sync_unit": {
68           "id": "foo",
69           "display_id": "foo",
70           "external_system_type": "adaas",
71           "is_archived": true,
72           "name": "foo",
73           "sync_run": {
74             "mode": "initial",
75             "progress": {
76               "state": "completed"
77             }
78           },
79           "sync_type": "manual"
80         }
81       },
82       "last_sync_out": {
83         "status": "failed",
84         "sync_date": "2023-01-01T12:00:00.000Z",
85         "sync_unit": {
86           "id": "foo",
87           "display_id": "foo",
88           "external_system_type": "adaas",
89           "is_archived": true,
90           "name": "foo",
91           "sync_run": {
92             "mode": "initial",
93             "progress": {
94               "state": "completed"
95             }
96           },
97           "sync_type": "manual"
98         }
99       },
100       "origin_system": "foo"
101     }
102   }
103 }

Creates a new group. A group is a collection of users.

Request

This endpoint expects an object.

descriptionstringRequiredformat: "text"

Description of the group.

namestringRequiredformat: "text"

Unique name of the group.

typeenumOptional

Type of the group.

Allowed values:

dynamic_group_infoobjectOptional

Information to define dynamic groups.

member_typeenumOptional

Type of the members in the group.

Allowed values:

ownerstringOptionalformat: "id"

Owner of the group.

Response

The response to group creation.

groupobject

Create Group

Headers

Request

Response

Errors