Customer Feedback Made Easy
REST API SetSurveyStatus Resource
Overview
The SetSurveyStatus resource sets a survey's status to active or inactive. The survey is specified using the SurveyId GUID returned by the ListSurveys resource.
Resource URI
POST https://www.cognotix.com/api/v1/setsurveystatus
Request Properties
| Property | Description |
|---|---|
| ObjectId | The globally unique identifier (GUID) used as the survey ID |
| AttributeName | The name of the attribute to modify, in this case "Status" |
| AttributeValue | The new attribute value, "Active" or "Inactive" |
Sample Request
{
"ObjectId":"e7325f64-0505-46e2-a68d-9dc60160xxxx",
"AttributeName":"Status",
"AttributeValue":"Inactive"
}
Response Properties
| Property | Description |
|---|---|
| SetSurveyStatusResult | String value of "success" or "failure" followed by the reason for failure |
Sample Response
{"SetSurveyStatusResult":"success"}