POST/projects/{project_id}/surveys

Create survey from template

Create a new survey from a canonical template. The survey starts in `draft` status — use `PATCH .../status` to flip it to `live` before the widget serves it. Returns 400 when the project has reached the 10-survey limit.

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

Parameters

project_idpathstringrequired

Unique identifier of the project (MongoDB ObjectId)

Example: 507f1f77bcf86cd799439011

Request Body

required

Template to instantiate.

application/json

CreateSurveyRequest

Request body for creating a survey from a canonical template.

templatestringrequired

Which canonical template to instantiate. `trial_exit` is intentionally excluded — that template requires billing context and is managed via the dashboard.

Enum:blanknpscsatces

Example: nps

Responses

Request

POST/projects/{project_id}/surveys

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

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