Create Directory

POST

Creates a directory for the specified inputs.

Request

This endpoint expects an object.

titlestringRequiredformat: "text"

Title of the directory.

descriptionstringOptionalformat: "text"

Description for the directory.

iconstringOptionalformat: "text"

Icon for the directory.

languagestringOptionalformat: "text"

Language of the directory.

parentstringOptionalformat: "id"

Parent directory of the directory.

publishedbooleanOptional

Whether the directory is published.

tagslist of objectsOptional

Tags associated with the directory.

thumbnailstringOptionalformat: "id"

ID of the thumbnail artifact.

Response

Create directory response.

directoryobject

POST

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

201Created

1 {
2   "directory": {
3     "body": {
4       "file": {
5         "type": "type",
6         "name": "name"
7       },
8       "id": "id",
9       "display_id": "display_id"
10     },
11     "created_by": {
12       "type": "dev_user",
13       "display_picture": {
14         "file": {
15           "type": "type",
16           "name": "name"
17         },
18         "id": "id",
19         "display_id": "display_id"
20       },
21       "id": "id",
22       "state": "active",
23       "display_id": "display_id",
24       "display_name": "display_name",
25       "email": "email",
26       "full_name": "full_name"
27     },
28     "id": "id",
29     "modified_by": {
30       "type": "dev_user",
31       "display_picture": {
32         "file": {
33           "type": "type",
34           "name": "name"
35         },
36         "id": "id",
37         "display_id": "display_id"
38       },
39       "id": "id",
40       "state": "active",
41       "display_id": "display_id",
42       "display_name": "display_name",
43       "email": "email",
44       "full_name": "full_name"
45     },
46     "parent": {
47       "id": "id",
48       "sync_metadata": {
49         "external_reference": "external_reference",
50         "origin_system": "origin_system"
51       },
52       "display_id": "display_id"
53     },
54     "sync_metadata": {
55       "last_sync_in": {
56         "status": "failed",
57         "sync_unit": {
58           "external_system_type": "adaas",
59           "id": "id",
60           "sync_run": {
61             "mode": "initial",
62             "progress": {
63               "state": "completed"
64             }
65           },
66           "sync_type": "manual",
67           "display_id": "display_id",
68           "is_archived": true,
69           "name": "name"
70         },
71         "sync_date": "sync_date"
72       },
73       "last_sync_out": {
74         "status": "failed",
75         "sync_unit": {
76           "external_system_type": "adaas",
77           "id": "id",
78           "sync_run": {
79             "mode": "initial",
80             "progress": {
81               "state": "completed"
82             }
83           },
84           "sync_type": "manual",
85           "display_id": "display_id",
86           "is_archived": true,
87           "name": "name"
88         },
89         "sync_date": "sync_date"
90       },
91       "external_reference": "external_reference",
92       "origin_system": "origin_system"
93     },
94     "thumbnail": {
95       "file": {
96         "type": "type",
97         "name": "name"
98       },
99       "id": "id",
100       "display_id": "display_id"
101     },
102     "created_date": "created_date",
103     "description": "description",
104     "display_id": "display_id",
105     "icon": "icon",
106     "modified_date": "modified_date",
107     "published": true,
108     "rank": "rank",
109     "tags": [
110       {
111         "tag": {
112           "id": "id",
113           "name": "name",
114           "style_new": {
115             "color": "color"
116           },
117           "display_id": "display_id"
118         },
119         "value": "value"
120       },
121       {
122         "tag": {
123           "id": "id",
124           "name": "name",
125           "style_new": {
126             "color": "color"
127           },
128           "display_id": "display_id"
129         },
130         "value": "value"
131       }
132     ],
133     "title": "title"
134   }
135 }

Delete Directory

Up Next

Built with

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

1	{
2	"directory": {
3	"body": {
4	"file": {
5	"type": "type",
6	"name": "name"
7	},
8	"id": "id",
9	"display_id": "display_id"
10	},
11	"created_by": {
12	"type": "dev_user",
13	"display_picture": {
14	"file": {
15	"type": "type",
16	"name": "name"
17	},
18	"id": "id",
19	"display_id": "display_id"
20	},
21	"id": "id",
22	"state": "active",
23	"display_id": "display_id",
24	"display_name": "display_name",
25	"email": "email",
26	"full_name": "full_name"
27	},
28	"id": "id",
29	"modified_by": {
30	"type": "dev_user",
31	"display_picture": {
32	"file": {
33	"type": "type",
34	"name": "name"
35	},
36	"id": "id",
37	"display_id": "display_id"
38	},
39	"id": "id",
40	"state": "active",
41	"display_id": "display_id",
42	"display_name": "display_name",
43	"email": "email",
44	"full_name": "full_name"
45	},
46	"parent": {
47	"id": "id",
48	"sync_metadata": {
49	"external_reference": "external_reference",
50	"origin_system": "origin_system"
51	},
52	"display_id": "display_id"
53	},
54	"sync_metadata": {
55	"last_sync_in": {
56	"status": "failed",
57	"sync_unit": {
58	"external_system_type": "adaas",
59	"id": "id",
60	"sync_run": {
61	"mode": "initial",
62	"progress": {
63	"state": "completed"
64	}
65	},
66	"sync_type": "manual",
67	"display_id": "display_id",
68	"is_archived": true,
69	"name": "name"
70	},
71	"sync_date": "sync_date"
72	},
73	"last_sync_out": {
74	"status": "failed",
75	"sync_unit": {
76	"external_system_type": "adaas",
77	"id": "id",
78	"sync_run": {
79	"mode": "initial",
80	"progress": {
81	"state": "completed"
82	}
83	},
84	"sync_type": "manual",
85	"display_id": "display_id",
86	"is_archived": true,
87	"name": "name"
88	},
89	"sync_date": "sync_date"
90	},
91	"external_reference": "external_reference",
92	"origin_system": "origin_system"
93	},
94	"thumbnail": {
95	"file": {
96	"type": "type",
97	"name": "name"
98	},
99	"id": "id",
100	"display_id": "display_id"
101	},
102	"created_date": "created_date",
103	"description": "description",
104	"display_id": "display_id",
105	"icon": "icon",
106	"modified_date": "modified_date",
107	"published": true,
108	"rank": "rank",
109	"tags": [
110	{
111	"tag": {
112	"id": "id",
113	"name": "name",
114	"style_new": {
115	"color": "color"
116	},
117	"display_id": "display_id"
118	},
119	"value": "value"
120	},
121	{
122	"tag": {
123	"id": "id",
124	"name": "name",
125	"style_new": {
126	"color": "color"
127	},
128	"display_id": "display_id"
129	},
130	"value": "value"
131	}
132	],
133	"title": "title"
134	}
135	}