Surveys
Update Survey
Updates a survey's metadata.
AuthorizationBearer <token>
All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request.
How do I find my token?
In: header
description?string
The updated description about the survey.
Format
textLength
length <= 1000header?string
Header of the survey.
Format
textLength
length <= 1000idstring
The ID of the survey to update.
Format
idintroductory_text?string
The updated text posted when introducing the survey to the responder.
Format
textLength
length <= 1000name?string
The survey's updated name.
Format
textLength
1 <= length <= 100response_text?string
Text posted after the response is collected.
Format
textLength
length <= 1000schema_with_metadata?array<survey-field-with-metadata>
The updated schema with metadata for the survey.
survey?stringDeprecated
The ID of the survey to update.
Format
idtitle?string
Title of the survey.
Format
textLength
length <= 1000Response Body
curl -X POST "https://api.devrev.ai/surveys.update" \ -H "Content-Type: application/json" \ -d '{ "id": "string" }'{
"survey": {
"created_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"created_date": "2023-01-01T12:00:00.000Z",
"display_id": "string",
"id": "string",
"modified_by": {
"type": "dev_user",
"display_id": "string",
"id": "string",
"display_name": "string",
"display_picture": {
"display_id": "string",
"id": "string",
"file": {
"type": "string",
"name": "string",
"size": 0
}
},
"email": "string",
"full_name": "string",
"state": "active"
},
"modified_date": "2023-01-01T12:00:00.000Z",
"description": "string",
"header": "string",
"introductory_text": "string",
"name": "string",
"response_text": "string",
"schema": [
{
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_name": "string"
}
]
}
],
"decimal_places": 0,
"display_name": "string",
"group_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_sortable": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
}
],
"schema_with_metadata": [
{
"field": {
"field_type": "array",
"description": "string",
"is_filterable": true,
"is_immutable": true,
"is_pii": true,
"is_required": true,
"mfz": {},
"name": "string",
"oasis": {},
"origin": "string",
"ui": {
"client_overrides": [
{
"client_name": "string",
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_overrides": [
{
"decimal_places": 0,
"display_name": "string",
"is_groupable": true,
"is_hidden": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"use_shorthand_notation": true,
"view_name": "string"
}
]
}
],
"decimal_places": 0,
"display_name": "string",
"group_name": "string",
"is_groupable": true,
"is_hidden": true,
"is_sortable": true,
"order": 0,
"placeholder": "string",
"tooltip": "string",
"unit": "string",
"use_shorthand_notation": true
},
"default_value": true
},
"metadata": {},
"question": "string"
}
],
"title": "string"
}
}{
"detail": "string",
"message": "string",
"type": "artifact_already_attached_to_a_parent",
"existing_parent": "string",
"is_same": true
}{
"detail": "string",
"message": "string",
"type": "unauthenticated"
}{
"detail": "string",
"message": "string",
"type": "forbidden"
}{
"detail": "string",
"message": "string",
"type": "too_many_requests",
"retry_after": 0
}{
"detail": "string",
"message": "string",
"type": "internal_error",
"reference_id": "string"
}{
"detail": "string",
"message": "string",
"type": "service_unavailable"
}