Update Survey

POST

Updates a survey’s metadata.

Request

This endpoint expects an object.

idstringRequiredformat: "id"

The ID of the survey to update.

descriptionstringOptionalformat: "text"<=1000 characters

The updated description about the survey.

headerstringOptionalformat: "text"<=1000 characters

Header of the survey.

introductory_textstringOptionalformat: "text"<=1000 characters

The updated text posted when introducing the survey to the responder.

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

The survey’s updated name.

response_textstringOptionalformat: "text"<=1000 characters

Text posted after the response is collected.

schema_with_metadatalist of objectsOptional

The updated schema with metadata for the survey.

titlestringOptionalformat: "text"<=1000 characters

Title of the survey.

surveystringOptionalformat: "id"Deprecated

The ID of the survey to update.

Response

Success.

surveyobject

Errors

POST

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

200surveysUpdateExample

1 {
2   "survey": {
3     "id": "foo",
4     "created_by": {
5       "display_id": "foo",
6       "id": "foo",
7       "display_name": "foo",
8       "display_picture": {
9         "display_id": "foo",
10         "id": "foo",
11         "file": {
12           "type": "foo",
13           "name": "foo",
14           "size": 42
15         }
16       },
17       "email": "foo",
18       "full_name": "foo",
19       "state": "active"
20     },
21     "created_date": "2023-01-01T12:00:00.000Z",
22     "description": "foo",
23     "display_id": "foo",
24     "header": "foo",
25     "introductory_text": "foo",
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     "response_text": "foo",
46     "schema": [
47       {
48         "description": "foo",
49         "is_filterable": true,
50         "is_immutable": true,
51         "is_pii": true,
52         "is_required": true,
53         "mfz": {},
54         "name": "foo",
55         "oasis": {},
56         "origin": "foo",
57         "ui": {},
58         "default_value": true
59       }
60     ],
61     "schema_with_metadata": [
62       {
63         "field": {
64           "description": "foo",
65           "is_filterable": true,
66           "is_immutable": true,
67           "is_pii": true,
68           "is_required": true,
69           "mfz": {},
70           "name": "foo",
71           "oasis": {},
72           "origin": "foo",
73           "ui": {},
74           "default_value": true
75         },
76         "metadata": {},
77         "question": "foo"
78       }
79     ],
80     "title": "foo"
81   }
82 }

List Sys Users

Up Next

Built with

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

1	{
2	"survey": {
3	"id": "foo",
4	"created_by": {
5	"display_id": "foo",
6	"id": "foo",
7	"display_name": "foo",
8	"display_picture": {
9	"display_id": "foo",
10	"id": "foo",
11	"file": {
12	"type": "foo",
13	"name": "foo",
14	"size": 42
15	}
16	},
17	"email": "foo",
18	"full_name": "foo",
19	"state": "active"
20	},
21	"created_date": "2023-01-01T12:00:00.000Z",
22	"description": "foo",
23	"display_id": "foo",
24	"header": "foo",
25	"introductory_text": "foo",
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	"response_text": "foo",
46	"schema": [
47	{
48	"description": "foo",
49	"is_filterable": true,
50	"is_immutable": true,
51	"is_pii": true,
52	"is_required": true,
53	"mfz": {},
54	"name": "foo",
55	"oasis": {},
56	"origin": "foo",
57	"ui": {},
58	"default_value": true
59	}
60	],
61	"schema_with_metadata": [
62	{
63	"field": {
64	"description": "foo",
65	"is_filterable": true,
66	"is_immutable": true,
67	"is_pii": true,
68	"is_required": true,
69	"mfz": {},
70	"name": "foo",
71	"oasis": {},
72	"origin": "foo",
73	"ui": {},
74	"default_value": true
75	},
76	"metadata": {},
77	"question": "foo"
78	}
79	],
80	"title": "foo"
81	}
82	}