Create

POST

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

Request

This endpoint expects an object.

descriptionstringRequired

Description of the group.

namestringRequired

Unique name of the group.

type"dynamic" or "static"Optional

Allowed values: dynamicstatic

Type of the group.

dynamic_group_infomap from strings to anyOptional

Information to define dynamic groups.

member_type"dev_user" or "rev_user"Optional

Allowed values: dev_userrev_user

Type of the members in the group.

ownerstringOptional

Owner of the group.

Response

This endpoint returns an object.

groupobject

POST

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": "description",
6   "name": "name"
7 }'

200Successful

1 {
2   "group": {
3     "id": "id",
4     "is_default": true,
5     "created_by": {
6       "type": "sys_user",
7       "id": "created_by",
8       "display_id": "created_by",
9       "display_name": "created_by",
10       "display_picture": {
11         "id": "id"
12       },
13       "email": "created_by",
14       "full_name": "created_by",
15       "state": "active"
16     },
17     "created_date": "2023-01-01T12:00:00Z",
18     "description": "description",
19     "display_id": "display_id",
20     "member_type": "dev_user",
21     "modified_by": {
22       "type": "sys_user",
23       "id": "modified_by",
24       "display_id": "modified_by",
25       "display_name": "modified_by",
26       "display_picture": {
27         "id": "id"
28       },
29       "email": "modified_by",
30       "full_name": "modified_by",
31       "state": "active"
32     },
33     "modified_date": "2023-01-01T12:00:00Z",
34     "name": "name",
35     "owner": {
36       "type": "sys_user",
37       "id": "owner",
38       "display_id": "owner",
39       "display_name": "owner",
40       "display_picture": {
41         "id": "id"
42       },
43       "email": "owner",
44       "full_name": "owner",
45       "state": "active"
46     },
47     "sync_metadata": {
48       "external_reference": "external_reference",
49       "last_sync_in": {
50         "sync_date": "2023-01-01T12:00:00Z"
51       },
52       "last_sync_out": {
53         "sync_date": "2023-01-01T12:00:00Z"
54       },
55       "origin_system": "origin_system"
56     }
57   }
58 }

Built with

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": "description",
6	"name": "name"
7	}'

1	{
2	"group": {
3	"id": "id",
4	"is_default": true,
5	"created_by": {
6	"type": "sys_user",
7	"id": "created_by",
8	"display_id": "created_by",
9	"display_name": "created_by",
10	"display_picture": {
11	"id": "id"
12	},
13	"email": "created_by",
14	"full_name": "created_by",
15	"state": "active"
16	},
17	"created_date": "2023-01-01T12:00:00Z",
18	"description": "description",
19	"display_id": "display_id",
20	"member_type": "dev_user",
21	"modified_by": {
22	"type": "sys_user",
23	"id": "modified_by",
24	"display_id": "modified_by",
25	"display_name": "modified_by",
26	"display_picture": {
27	"id": "id"
28	},
29	"email": "modified_by",
30	"full_name": "modified_by",
31	"state": "active"
32	},
33	"modified_date": "2023-01-01T12:00:00Z",
34	"name": "name",
35	"owner": {
36	"type": "sys_user",
37	"id": "owner",
38	"display_id": "owner",
39	"display_name": "owner",
40	"display_picture": {
41	"id": "id"
42	},
43	"email": "owner",
44	"full_name": "owner",
45	"state": "active"
46	},
47	"sync_metadata": {
48	"external_reference": "external_reference",
49	"last_sync_in": {
50	"sync_date": "2023-01-01T12:00:00Z"
51	},
52	"last_sync_out": {
53	"sync_date": "2023-01-01T12:00:00Z"
54	},
55	"origin_system": "origin_system"
56	}
57	}
58	}