PATCH/projects/{project_id}/surveys/{survey_id}/status

Update survey status

Change a survey's lifecycle status. Flipping to `live` enables dispatch and widget serving. Flipping to `paused` suppresses triggers without deleting the definition. Returns the updated survey.

Base URLhttps://seggwat.com/api/v1

Parameters

project_idpathstringrequired

Unique identifier of the project (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011

survey_idpathstringrequired

MongoDB ObjectId of the survey

Example: 6630f1c7c2b3a40a1e9e1b22

Request Body

required

New lifecycle status.

application/json

SetSurveyStatusRequest

Request body for updating a survey's lifecycle status.

statusSurveyStatusrequired

Authoring/lifecycle status of a survey. Only `live` surveys are served by the widget or fired by the lifecycle dispatcher.

Enum:draftlivepausedarchived

Responses

Request

PATCH/projects/{project_id}/surveys/{survey_id}/status

curl \
  -X PATCH \
  "https://seggwat.com/api/v1/projects/string/surveys/string/status" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "draft"
}'

Response

200application/json

{
  "cooldown_days": 90,
  "copy": {
    "locales": {
      "de": {
        "title": "Wie zufrieden sind Sie?",
        "submit_label": "Absenden"
      }
    }
  },
  "created_at": "2024-01-15T10:30:00Z",
  "display_mode": "banner",
  "id": "6630f1c7c2b3a40a1e9e1b22",
  "name": "Pricing page intent",
  "project_id": "507f1f77bcf86cd799439011",
  "questions": [
    {
      "help_text": "string",
      "id": "q_nps_1",
      "kind": "any",
      "prompt": "How likely are you to recommend us to a friend?",
      "required": true
    }
  ],
  "sample_rate": 1.0,
  "status": "draft",
  "thank_you": "any",
  "trigger": "any",
  "updated_at": "2024-01-20T14:00:00Z"
}

Navigation