Create Survey

POST

Creates a schema for survey, which includes name and description of schema.

Request

This endpoint expects an object.

namestringRequiredformat: "text">=1 character<=100 characters

The survey’s name.

descriptionstringOptionalformat: "text"<=1000 characters

Description about the survey.

headerstringOptionalformat: "text"<=1000 characters

Header of the survey.

introductory_textstringOptionalformat: "text"<=1000 characters

Text posted when introducing the survey to the responder.

response_textstringOptionalformat: "text"<=1000 characters

Text posted after the response is collected.

schemalist of objectsOptional

Schema for the survey.

schema_with_metadatalist of objectsOptional

The schema with metadata for the survey.

titlestringOptionalformat: "text"<=1000 characters

Title of the survey.

Response

Success.

surveyobject

POST

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

201Created

1 {
2   "survey": {
3     "id": "id",
4     "created_by": {
5       "type": "dev_user",
6       "id": "id",
7       "display_id": "display_id",
8       "display_name": "display_name",
9       "display_picture": {
10         "id": "id",
11         "display_id": "display_id",
12         "file": {}
13       },
14       "email": "email",
15       "full_name": "full_name",
16       "state": "active"
17     },
18     "created_date": "created_date",
19     "description": "description",
20     "display_id": "display_id",
21     "header": "header",
22     "introductory_text": "introductory_text",
23     "modified_by": {
24       "type": "dev_user",
25       "id": "id",
26       "display_id": "display_id",
27       "display_name": "display_name",
28       "display_picture": {
29         "id": "id",
30         "display_id": "display_id",
31         "file": {}
32       },
33       "email": "email",
34       "full_name": "full_name",
35       "state": "active"
36     },
37     "modified_date": "modified_date",
38     "name": "name",
39     "response_text": "response_text",
40     "schema": [
41       {
42         "field_type": "array",
43         "base_type": "bool",
44         "description": "description",
45         "is_filterable": true,
46         "is_immutable": true,
47         "is_pii": true,
48         "is_required": true,
49         "mfz": {},
50         "name": "name",
51         "oasis": {},
52         "origin": "origin",
53         "ui": {
54           "client_overrides": [
55             {},
56             {}
57           ],
58           "create_view": {},
59           "detail_view": {},
60           "display_name": "display_name",
61           "filter_view": {},
62           "group_name": "group_name",
63           "is_active_in_detail_view": true,
64           "is_bulk_action_enabled": true,
65           "is_currency_field": true,
66           "is_groupable": true,
67           "is_hidden": true,
68           "is_hidden_during_create": true,
69           "is_read_only": true,
70           "is_required": true,
71           "is_shown_in_summary": true,
72           "is_sortable": true,
73           "list_view": {},
74           "order": 1,
75           "placeholder": "placeholder",
76           "summary_view": {},
77           "tooltip": "tooltip",
78           "unit": "unit"
79         },
80         "default_value": [
81           true,
82           true
83         ],
84         "eq_items": 1000000,
85         "max_items": 1000000,
86         "min_items": 1000000
87       },
88       {
89         "field_type": "array",
90         "base_type": "bool",
91         "description": "description",
92         "is_filterable": true,
93         "is_immutable": true,
94         "is_pii": true,
95         "is_required": true,
96         "mfz": {},
97         "name": "name",
98         "oasis": {},
99         "origin": "origin",
100         "ui": {
101           "client_overrides": [
102             {},
103             {}
104           ],
105           "create_view": {},
106           "detail_view": {},
107           "display_name": "display_name",
108           "filter_view": {},
109           "group_name": "group_name",
110           "is_active_in_detail_view": true,
111           "is_bulk_action_enabled": true,
112           "is_currency_field": true,
113           "is_groupable": true,
114           "is_hidden": true,
115           "is_hidden_during_create": true,
116           "is_read_only": true,
117           "is_required": true,
118           "is_shown_in_summary": true,
119           "is_sortable": true,
120           "list_view": {},
121           "order": 1,
122           "placeholder": "placeholder",
123           "summary_view": {},
124           "tooltip": "tooltip",
125           "unit": "unit"
126         },
127         "default_value": [
128           true,
129           true
130         ],
131         "eq_items": 1000000,
132         "max_items": 1000000,
133         "min_items": 1000000
134       }
135     ],
136     "schema_with_metadata": [
137       {
138         "field": {
139           "field_type": "array",
140           "base_type": "bool",
141           "description": "description",
142           "is_filterable": true,
143           "is_immutable": true,
144           "is_pii": true,
145           "is_required": true,
146           "mfz": {},
147           "name": "name",
148           "oasis": {},
149           "origin": "origin",
150           "ui": {},
151           "default_value": [
152             true,
153             true
154           ],
155           "eq_items": 1000000,
156           "max_items": 1000000,
157           "min_items": 1000000
158         },
159         "metadata": {},
160         "question": "question"
161       },
162       {
163         "field": {
164           "field_type": "array",
165           "base_type": "bool",
166           "description": "description",
167           "is_filterable": true,
168           "is_immutable": true,
169           "is_pii": true,
170           "is_required": true,
171           "mfz": {},
172           "name": "name",
173           "oasis": {},
174           "origin": "origin",
175           "ui": {},
176           "default_value": [
177             true,
178             true
179           ],
180           "eq_items": 1000000,
181           "max_items": 1000000,
182           "min_items": 1000000
183         },
184         "metadata": {},
185         "question": "question"
186       }
187     ],
188     "title": "title"
189   }
190 }

Delete Survey

Up Next

Built with

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

1	{
2	"survey": {
3	"id": "id",
4	"created_by": {
5	"type": "dev_user",
6	"id": "id",
7	"display_id": "display_id",
8	"display_name": "display_name",
9	"display_picture": {
10	"id": "id",
11	"display_id": "display_id",
12	"file": {}
13	},
14	"email": "email",
15	"full_name": "full_name",
16	"state": "active"
17	},
18	"created_date": "created_date",
19	"description": "description",
20	"display_id": "display_id",
21	"header": "header",
22	"introductory_text": "introductory_text",
23	"modified_by": {
24	"type": "dev_user",
25	"id": "id",
26	"display_id": "display_id",
27	"display_name": "display_name",
28	"display_picture": {
29	"id": "id",
30	"display_id": "display_id",
31	"file": {}
32	},
33	"email": "email",
34	"full_name": "full_name",
35	"state": "active"
36	},
37	"modified_date": "modified_date",
38	"name": "name",
39	"response_text": "response_text",
40	"schema": [
41	{
42	"field_type": "array",
43	"base_type": "bool",
44	"description": "description",
45	"is_filterable": true,
46	"is_immutable": true,
47	"is_pii": true,
48	"is_required": true,
49	"mfz": {},
50	"name": "name",
51	"oasis": {},
52	"origin": "origin",
53	"ui": {
54	"client_overrides": [
55	{},
56	{}
57	],
58	"create_view": {},
59	"detail_view": {},
60	"display_name": "display_name",
61	"filter_view": {},
62	"group_name": "group_name",
63	"is_active_in_detail_view": true,
64	"is_bulk_action_enabled": true,
65	"is_currency_field": true,
66	"is_groupable": true,
67	"is_hidden": true,
68	"is_hidden_during_create": true,
69	"is_read_only": true,
70	"is_required": true,
71	"is_shown_in_summary": true,
72	"is_sortable": true,
73	"list_view": {},
74	"order": 1,
75	"placeholder": "placeholder",
76	"summary_view": {},
77	"tooltip": "tooltip",
78	"unit": "unit"
79	},
80	"default_value": [
81	true,
82	true
83	],
84	"eq_items": 1000000,
85	"max_items": 1000000,
86	"min_items": 1000000
87	},
88	{
89	"field_type": "array",
90	"base_type": "bool",
91	"description": "description",
92	"is_filterable": true,
93	"is_immutable": true,
94	"is_pii": true,
95	"is_required": true,
96	"mfz": {},
97	"name": "name",
98	"oasis": {},
99	"origin": "origin",
100	"ui": {
101	"client_overrides": [
102	{},
103	{}
104	],
105	"create_view": {},
106	"detail_view": {},
107	"display_name": "display_name",
108	"filter_view": {},
109	"group_name": "group_name",
110	"is_active_in_detail_view": true,
111	"is_bulk_action_enabled": true,
112	"is_currency_field": true,
113	"is_groupable": true,
114	"is_hidden": true,
115	"is_hidden_during_create": true,
116	"is_read_only": true,
117	"is_required": true,
118	"is_shown_in_summary": true,
119	"is_sortable": true,
120	"list_view": {},
121	"order": 1,
122	"placeholder": "placeholder",
123	"summary_view": {},
124	"tooltip": "tooltip",
125	"unit": "unit"
126	},
127	"default_value": [
128	true,
129	true
130	],
131	"eq_items": 1000000,
132	"max_items": 1000000,
133	"min_items": 1000000
134	}
135	],
136	"schema_with_metadata": [
137	{
138	"field": {
139	"field_type": "array",
140	"base_type": "bool",
141	"description": "description",
142	"is_filterable": true,
143	"is_immutable": true,
144	"is_pii": true,
145	"is_required": true,
146	"mfz": {},
147	"name": "name",
148	"oasis": {},
149	"origin": "origin",
150	"ui": {},
151	"default_value": [
152	true,
153	true
154	],
155	"eq_items": 1000000,
156	"max_items": 1000000,
157	"min_items": 1000000
158	},
159	"metadata": {},
160	"question": "question"
161	},
162	{
163	"field": {
164	"field_type": "array",
165	"base_type": "bool",
166	"description": "description",
167	"is_filterable": true,
168	"is_immutable": true,
169	"is_pii": true,
170	"is_required": true,
171	"mfz": {},
172	"name": "name",
173	"oasis": {},
174	"origin": "origin",
175	"ui": {},
176	"default_value": [
177	true,
178	true
179	],
180	"eq_items": 1000000,
181	"max_items": 1000000,
182	"min_items": 1000000
183	},
184	"metadata": {},
185	"question": "question"
186	}
187	],
188	"title": "title"
189	}
190	}