Update Survey

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 "client_overrides": [ 59 { 60 "client_name": "foo", 61 "decimal_places": 42, 62 "display_name": "foo", 63 "is_groupable": true, 64 "is_hidden": true, 65 "order": 42, 66 "placeholder": "foo", 67 "tooltip": "foo", 68 "use_shorthand_notation": true, 69 "view_overrides": [ 70 { 71 "decimal_places": 42, 72 "display_name": "foo", 73 "is_groupable": true, 74 "is_hidden": true, 75 "order": 42, 76 "placeholder": "foo", 77 "tooltip": "foo", 78 "use_shorthand_notation": true, 79 "view_name": "foo" 80 } 81 ] 82 } 83 ], 84 "decimal_places": 42, 85 "display_name": "foo", 86 "group_name": "foo", 87 "is_groupable": true, 88 "is_hidden": true, 89 "is_sortable": true, 90 "order": 42, 91 "placeholder": "foo", 92 "tooltip": "foo", 93 "unit": "foo", 94 "use_shorthand_notation": true 95 }, 96 "default_value": true 97 } 98 ], 99 "schema_with_metadata": [ 100 { 101 "field": { 102 "description": "foo", 103 "is_filterable": true, 104 "is_immutable": true, 105 "is_pii": true, 106 "is_required": true, 107 "mfz": {}, 108 "name": "foo", 109 "oasis": {}, 110 "origin": "foo", 111 "ui": { 112 "client_overrides": [ 113 { 114 "client_name": "foo", 115 "decimal_places": 42, 116 "display_name": "foo", 117 "is_groupable": true, 118 "is_hidden": true, 119 "order": 42, 120 "placeholder": "foo", 121 "tooltip": "foo", 122 "use_shorthand_notation": true, 123 "view_overrides": [ 124 {} 125 ] 126 } 127 ], 128 "decimal_places": 42, 129 "display_name": "foo", 130 "group_name": "foo", 131 "is_groupable": true, 132 "is_hidden": true, 133 "is_sortable": true, 134 "order": 42, 135 "placeholder": "foo", 136 "tooltip": "foo", 137 "unit": "foo", 138 "use_shorthand_notation": true 139 }, 140 "default_value": true 141 }, 142 "metadata": {}, 143 "question": "foo" 144 } 145 ], 146 "title": "foo" 147 } 148 }

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

Headers

Request

Response

Errors