Create Survey

POST

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

Request

This endpoint expects an object.

namestringRequired>=1 character<=100 characters

The survey’s name.

descriptionstringOptional<=1000 characters

Description about the survey.

headerstringOptional<=1000 characters

Header of the survey.

introductory_textstringOptional<=1000 characters

Text posted when introducing the survey to the responder.

response_textstringOptional<=1000 characters

Text posted after the response is collected.

schemalist of maps from strings to anyOptional

Schema for the survey.

schema_with_metadatalist of objectsOptional

The schema with metadata for the survey.

titlestringOptional<=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": "name"
6 }'

201Created

1 {
2   "survey": {
3     "id": "id",
4     "created_by": {
5       "type": "sys_user",
6       "id": "created_by",
7       "display_id": "created_by",
8       "display_name": "created_by",
9       "display_picture": {
10         "id": "id"
11       },
12       "email": "created_by",
13       "full_name": "created_by",
14       "state": "active"
15     },
16     "created_date": "2023-01-01T12:00:00Z",
17     "description": "description",
18     "display_id": "display_id",
19     "header": "header",
20     "introductory_text": "introductory_text",
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     "response_text": "response_text",
36     "schema": [
37       {
38         "field_type": "unknown",
39         "name": "schema"
40       }
41     ],
42     "schema_with_metadata": [
43       {}
44     ],
45     "title": "title"
46   }
47 }

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

1	{
2	"survey": {
3	"id": "id",
4	"created_by": {
5	"type": "sys_user",
6	"id": "created_by",
7	"display_id": "created_by",
8	"display_name": "created_by",
9	"display_picture": {
10	"id": "id"
11	},
12	"email": "created_by",
13	"full_name": "created_by",
14	"state": "active"
15	},
16	"created_date": "2023-01-01T12:00:00Z",
17	"description": "description",
18	"display_id": "display_id",
19	"header": "header",
20	"introductory_text": "introductory_text",
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	"response_text": "response_text",
36	"schema": [
37	{
38	"field_type": "unknown",
39	"name": "schema"
40	}
41	],
42	"schema_with_metadata": [
43	{}
44	],
45	"title": "title"
46	}
47	}