Flashpoint.AIFlashpoint.AIdocs

Templates

Templates are pre-built survey designs you can start from instead of building from scratch. Each template contains a complete survey document — blocks, questions, options, logic, and settings — ready to customize for your project.

Categories

Templates are organized into four categories:

CategoryDescriptionExamples
brandBrand health, perception, and awareness studiesBrand tracker, competitive perception, brand awareness
cxCustomer experience and satisfactionCSAT survey, post-purchase feedback, customer effort score
employeeInternal workforce researchEmployee engagement, onboarding feedback, pulse check
customTeam-created templates saved from previous surveysAny survey saved as a template by your team

The first three categories contain platform-provided templates available to all teams. The custom category is team-scoped — templates you save are only visible to your team.

Listing templates

Retrieve available templates, optionally filtered by category.

curl "https://surveys.flashpoint.ai/api/v1/templates?category=brand&limit=10" \
  -H "X-Service-Token: $TOKEN" \
  -H "X-Team-ID: $TEAM_ID" \
  -H "X-User-ID: $USER_ID"

Response:

{
  "items": [
    {
      "id": "tmpl-001-aabb-ccdd-eeff-112233445566",
      "name": "Brand Health Tracker",
      "description": "Quarterly brand awareness, consideration, and usage tracking with competitive benchmarking. Includes aided/unaided awareness, brand attributes grid, and NPS.",
      "category": "brand",
      "is_public": true,
      "usage_count": 142,
      "created_by": "system",
      "created_at": "2026-01-15T00:00:00Z",
      "updated_at": "2026-03-10T00:00:00Z"
    },
    {
      "id": "tmpl-002-aabb-ccdd-eeff-112233445566",
      "name": "Competitive Perception Study",
      "description": "Head-to-head brand comparison using grid ratings, MaxDiff importance scaling, and open-ended probes.",
      "category": "brand",
      "is_public": true,
      "usage_count": 87,
      "created_by": "system",
      "created_at": "2026-01-15T00:00:00Z",
      "updated_at": "2026-02-20T00:00:00Z"
    }
  ],
  "total": 2,
  "limit": 10,
  "offset": 0
}

Agent

"Show me brand survey templates"

"What templates do we have for customer experience?"

Getting template details

To inspect the full document inside a template before using it:

curl https://surveys.flashpoint.ai/api/v1/templates/$TEMPLATE_ID \
  -H "X-Service-Token: $TOKEN" \
  -H "X-Team-ID: $TEAM_ID" \
  -H "X-User-ID: $USER_ID"

The response includes all metadata fields plus the data object containing the full survey document (blocks, questions, options, logic).

Creating a survey from a template

Create a new draft survey pre-populated with the template's content.

curl -X POST https://surveys.flashpoint.ai/api/v1/templates/$TEMPLATE_ID/create-survey \
  -H "Content-Type: application/json" \
  -H "X-Service-Token: $TOKEN" \
  -H "X-Team-ID: $TEAM_ID" \
  -H "X-User-ID: $USER_ID" \
  -d '{ "name": "Q2 Brand Health Tracker" }'

Response (201 Created):

{
  "survey_id": "new-survey-uuid-here",
  "version": 1
}

The new survey starts in draft status with all the template's questions, blocks, and logic. Customize it with any of the Build operations — add or remove questions, change options, update logic — before publishing.

If you omit the name field, the survey is named after the template (e.g., "Brand Health Tracker Survey").

Agent

"Create a survey from the Brand Health Tracker template"

"Use the CSAT template to start a new post-purchase feedback survey called Q2 Checkout Experience"

Saving a survey as a template

Turn any survey into a reusable template. The survey's current document is snapshot into the template — future edits to the survey do not affect the saved template.

curl -X POST https://surveys.flashpoint.ai/api/v1/templates/from-survey/$SURVEY_ID \
  -H "Content-Type: application/json" \
  -H "X-Service-Token: $TOKEN" \
  -H "X-Team-ID: $TEAM_ID" \
  -H "X-User-ID: $USER_ID" \
  -d '{
    "name": "Standard Brand Tracker v2",
    "description": "Updated brand tracker with MaxDiff importance scaling and AI follow-up probes",
    "category": "custom"
  }'

Response (201 Created):

{
  "id": "tmpl-new-uuid-here",
  "name": "Standard Brand Tracker v2",
  "description": "Updated brand tracker with MaxDiff importance scaling and AI follow-up probes",
  "category": "custom",
  "is_public": false,
  "usage_count": 0,
  "created_by": "f0e1d2c3-b4a5-6789-0123-456789abcdef",
  "created_at": "2026-05-26T16:00:00Z",
  "updated_at": "2026-05-26T16:00:00Z",
  "data": {
    "blocks": [ "..." ]
  }
}

All fields are optional except category. If name is omitted, it defaults to the survey's name with "Template" appended.

Agent

"Save this survey as a template"

"Save the Q1 brand study as a template called Standard Brand Tracker in the brand category"

Deleting a template

curl -X DELETE https://surveys.flashpoint.ai/api/v1/templates/$TEMPLATE_ID \
  -H "X-Service-Token: $TOKEN" \
  -H "X-Team-ID: $TEAM_ID" \
  -H "X-User-ID: $USER_ID"

Response: 204 No Content.

Deleting a template does not affect surveys that were previously created from it.

Visibility

is_publicWho can see itWho can create it
trueAll teams on the platformPlatform administrators only
falseOnly the team that created itAny team member

Templates saved via POST /api/v1/templates/from-survey/{survey_id} default to is_public: false (team-scoped). Platform-provided templates in the brand, cx, and employee categories are public.

Workflow example

A typical template-driven workflow:

  1. Browse — "Show me CX templates" to see what is available
  2. Create — "Create a survey from the CSAT template called Q2 Checkout Experience"
  3. Customize — add project-specific questions, update option lists, configure skip logic
  4. Publish — "Publish the survey" once customization is complete
  5. Save back — "Save this survey as a template called Checkout Experience v2" to capture improvements for next quarter

Next steps