> ## Documentation Index > Fetch the complete documentation index at: https://formbricks.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create a survey draft payload with AI > Creates a strict v3 `POST /api/v3/surveys` create payload from a creator prompt and returns validation metadata. This endpoint is single-purpose: it does **not** persist the survey. Clients should validate the returned payload with `/api/v3/surveys/validate` or use the embedded validation metadata, then create the draft through `POST /api/v3/surveys`. The generated payload always sets `status: draft`. Both `type: link` and `type: app` are supported; for `app`, the payload includes a default `distribution` (display once, no triggers, no targeting) that you finish configuring in the editor or via the create request. Prompt privacy: prompt text is sent to the configured AI provider to create the payload, but this endpoint does not store prompts and server logs should use request ids and failure categories instead of raw prompt content. ## OpenAPI ````yaml /api-v3-reference/openapi.yml post /api/v3/surveys/generate openapi: 3.1.1 info: title: Formbricks API v3 description: > **Surveys**: **GET /api/v3/surveys**, **POST /api/v3/surveys**, **POST /api/v3/surveys/generate**, **POST /api/v3/surveys/validate**, **GET /api/v3/surveys/{surveyId}**, **PATCH /api/v3/surveys/{surveyId}**, **PATCH /api/v3/surveys/{surveyId}/blocks**, **PUT /api/v3/surveys/{surveyId}/blocks/order**, and **DELETE /api/v3/surveys/{surveyId}**. **Custom CSS**: survey CSS through `customCss` on **POST /api/v3/surveys**, **GET** and **PATCH /api/v3/surveys/{surveyId}**, workspace CSS through **GET** and **PATCH /api/v3/workspaces/{workspaceId}/custom-css**, and previews through `operation: customCss` on **POST /api/v3/surveys/validate**. Writes take and reads return source only; the server compiles it, returns removed constructs as top-level `warnings`, and never accepts compiled output. **Responses**: **GET /api/v3/responses**, **GET /api/v3/responses/count**, **POST /api/v3/responses/validate**, **POST /api/v3/responses/batch-delete**, **GET /api/v3/responses/{responseId}**, **POST /api/v3/responses**, **PATCH /api/v3/responses/{responseId}**, and **DELETE /api/v3/responses/{responseId}**. **Workflows extension**: **GET /api/v3/workflows**, **POST /api/v3/workflows**, **GET /api/v3/workflows/{workflowId}**, **PATCH /api/v3/workflows/{workflowId}**, **DELETE /api/v3/workflows/{workflowId}**, **POST /api/v3/workflows/{workflowId}/duplicate**, **POST /api/v3/workflows/{workflowId}/enable**, **POST /api/v3/workflows/{workflowId}/disable**, **POST /api/v3/workflows/{workflowId}/archive**, **POST /api/v3/workflows/{workflowId}/unarchive**, **POST /api/v3/workflows/{workflowId}/test**, **GET /api/v3/workflows/runs**, and **GET /api/v3/workflows/runs/{runId}**. Authenticate all management endpoints with **session cookie** or **`x-api-key`** (management key with access to the workspace). **Spec location:** source of truth is the multi-file tree at `docs/api-v3-reference/src/` (root `openapi.yml` plus one file per path and component); `docs/api-v3-reference/openapi.yml` is the generated single-file bundle (alongside v2 at `docs/api-v2-reference/openapi.yml`). **workspaceId** `workspaceId` is the canonical container identifier for this API. It is a **required query parameter on collection read endpoints** (`GET /api/v3/surveys`, `GET /api/v3/action-classes`, `GET /api/v3/contact-attribute-keys`) because those operate within a workspace. **`POST /api/v3/surveys` instead requires `workspaceId` in the request body**, not as a query parameter. Single-resource endpoints (`GET`/`PATCH`/`DELETE /api/v3/surveys/{surveyId}`) locate the resource by its globally-unique id and resolve the workspace from it, so they do **not** accept a `workspaceId` query parameter — sending one returns **400** with an `invalid_params` entry naming the key itself (`name: "workspaceId"`, `reason: "Unsupported field 'workspaceId'"`), rather than one naming the body. **Auth** Authenticate with either a session cookie or **`x-api-key`**. In dual-auth mode, V3 checks the API key first when the header is present, otherwise it uses the session path. Unauthenticated callers get **401** before query validation. **Pagination** Cursor-based pagination with **limit** + opaque **cursor** token. Responses return `meta.nextCursor`; pass that value back as `cursor` to fetch the next page. Survey list responses also include `meta.totalCount`, the total number of surveys matching the current filters across all pages. Workflow list responses do not require total counts in Scope 1. There is no `offset` in this contract. The page-size **maximum is 250** for responses, surveys, action classes and contact attribute keys; only the *default* varies by resource (20 for surveys, 50 for the workspace reference lists). **The workflows and workflow-run lists remain at 100** — their bound lives in the `packages/workflows` contracts and moves with that package, so each documents the value it actually enforces. A `limit` above an endpoint's maximum is rejected with **400** rather than silently reduced, consistent with v3 rejecting unrecognized query parameters instead of ignoring them. Callers should not infer the end of a collection from a page shorter than `limit`; `meta.nextCursor` of `null` is the only end-of-collection signal. Note that array-valued *input* bounds are a separate concern and stay at 100 — `filter[id][in]` and the batch-delete id list are bounded by write and payload risk, not by page cost. **Strictness** A query parameter that an operation does not declare returns **400**, with the offending key reported in `invalid_params[].name` — including on operations that declare no query parameters at all. Unknown parameters are rejected rather than ignored on purpose: a silently-dropped filter returns *more* data than the caller believes they asked for, and a typo in a filter name is indistinguishable from no filter at all. The same applies to request bodies, where unsupported fields are rejected instead of stripped. Unrecognized **headers** are tolerated, as gateways and proxies legitimately add them; strictness is about parameters and body fields, not transport metadata. This is the rule for the surveys, responses, tags and workspace reference-list operations. The workflows family does not enforce it today, so treat parameter strictness there as unspecified rather than guaranteed. **Request limits** A request body may be at most **2 MB**; a larger one is refused with **413** before it is read. Inside a body, **no array may hold more than 1 000 items, and all arrays together may hold at most 50 000 elements**, at any depth — a body that exceeds either bound is refused with **400** and a single `invalid_params` entry naming the offending array, before any field is validated. The same holds for nesting: a body may nest at most **256** levels of objects and arrays, counted from the root, and a deeper one is refused the same way, naming where it went too deep. Fields with a tighter bound document it as `maxItems` on the field (a survey's `blocks`, `endings`, `variables`, `languages`, `hiddenFields.fieldIds` and `distribution.triggers` since 0.2.0). A 400 or 422 lists at most **50** `invalid_params` entries; when there are more, the last entry says how many were left out. Since 0.2.0. **Filtering** Filters use explicit operator-style query parameters under the **`filter[...]` family**. The survey list supports `filter[name][contains]`, `filter[status][in]`, and `filter[type][in]`. The workflow list supports `filter[name][contains]` and `filter[status][in]`; the workflow run list supports `filter[status][in]` and `filter[isDryRun][eq]`. Resource-scoping identifiers (`workspaceId`, `workflowId`, `responseId`) stay plain query parameters. Multi-value filters use repeated keys or comma-separated values (e.g. `filter[status][in]=draft&filter[status][in]=inProgress` or `filter[status][in]=draft,inProgress`). Sorting remains a flat `sortBy` query parameter. **Responses** The response resource is **self-describing**. Answers come back as a typed `answers[]` array in which each entry carries the element's id, label, type and value, rather than as a map keyed by element id — so a consumer holding only a response can read it without fetching the survey and joining. Hidden fields, survey variables and auto-captured context are one `embeddedData[]` collection rather than three parallel concepts, each entry declaring a `kind` and a `type`. Data whose element has since been deleted is reported in `unresolved[]` instead of being dropped silently. Labels are resolved at read time against the current survey definition, and the `resolution` object discloses that policy along with the survey's `updatedAt` so a consumer can detect wording drift. Writes take answers in the **stored map form** (`data`) while reads return the typed array. Resolving ids into labelled answers is unambiguous; the reverse would mean matching caller-supplied labels back onto option ids, so the write side keeps the stored shape. To stop that costing round-trippability, the **detailed read returns `data` unchanged** — so a single-response read can be edited and sent back as `PATCH { "data": … }`, and the typed `answers[]` array is an addition rather than a replacement. One case where that round trip does not close: a write bound applies to `data` on the way in (`ResponseDataMapInput`) and none applies to the stored map, because v1 and v2 wrote it without one. A response carrying more answer keys than the write accepts therefore cannot be corrected through `PATCH` at all — the whole map is rejected, and sending a smaller one is not a workaround, because `data` is replaced wholesale and every key left out is deleted. Correct those through the v1/v2 management API or the dashboard. This is reachable only on surveys with more elements than the bound allows. Embedded Data is the exception, and it is symmetric rather than round-tripped: hidden fields and variables are read and written through `embeddedData`, addressed by **name** in both directions. No raw map of them is echoed, because a name is already what a write accepts — publishing the storage keys underneath (a variable's is its cuid) would expose a layout the caller has no use for. `data` therefore carries element answers only. Of those two, only `data` carries no `readOnly`, because it is the same map on the way in and on the way out. Embedded Data is writable through the **request's own** `embeddedData` map, not through the response field of that name — so `embeddedData[]`, like every other derived view on the resource, is marked `readOnly`, per its meaning of server-managed. `ResponseResource` lists them all. The list view omits `data`, since a bulk reader is not editing. `POST /api/v3/responses/validate` exists so a caller can see what a map would produce, and what a write would do, before committing to it. `createdAt` and `updatedAt` are **server-owned** on this resource: they cannot be supplied on create or changed by a patch. Response metering counts rows by `(surveyId, createdAt)`, and a client-chosen `createdAt` also lets rows be inserted into the middle of another consumer's already-paginated stream. Backdating stays available on v2 until a dedicated import path exists. The respondent's IP address and the `contactAttributes` snapshot that v1/v2 expose are not part of this resource in any view; that snapshot is copied from the contact at submission time and never refreshed, so it is stale PII by construction. Response filtering is allow-listed and index-backed: `filter[createdAt][gte|gt|lte|lt]` (at most one lower and one upper bound — `gte` xor `gt`, `lte` xor `lt`), `filter[finished][eq]`, `filter[language][in]` and `filter[id][in]`. `filter[finished][eq]` and `filter[language][in]` require `surveyId` or `contactId` as well, because both are heap residuals bounded only by an anchored index range. Per-answer, hidden-field, submission-metadata, contact-attribute, quota and tag filters are **not** offered; each is a JSON path or an unindexed join on the largest table in the product. The in-app dashboard does offer them, so this API is knowingly behind the dashboard here — closing the gap requires index work and is tracked separately rather than quietly omitted. `GET /api/v3/responses/count` answers "how many match?" directly. The list endpoint's `meta.totalCount` covers a caller that is already paging and is **opt-in** via `includeTotalCount` (default `false`, unlike the survey list) because responses are the highest-cardinality table in the product. Both response counts are **capped at 10 000** and carry an exactness flag — `meta.totalCountRelation` on the list, `data.relation` on `/count` — reading `eq` when the figure is exact and `gte` when the cap was reached and it is a lower bound. An exact count over this table grows superlinearly with the data while a capped one stays flat, so an uncapped total would be the only part of a response whose cost is unbounded. `/count` accepts `precision=exact` for the cases that genuinely need a precise figure, documented as the deliberate slow path. The survey list's `totalCount` stays exact and uncapped: surveys are low-cardinality and that count has a covering index built for it. Bulk deletion is `POST /api/v3/responses/batch-delete`, a custom method rather than a collection-level `DELETE`, so a call that loses its filters cannot degrade into erasing everything in scope. It scope-filters rather than rejecting: foreign and already-deleted ids are ignored and the call reports how many rows it removed, which keeps it both leak-free and safe to retry. **Security** Missing/forbidden workspace returns **403** with a generic message (not **404**) so resource existence is not leaked. Workflow and workflow-run detail endpoints also return **403** for unknown IDs or inaccessible IDs to avoid IDOR leaks. List responses use `private, no-store`. **AI survey creation** `POST /api/v3/surveys/generate` returns a draft `POST /api/v3/surveys` payload plus validation metadata. It does not create a survey. It generates survey content for both `link` and `app` surveys; for `app` it seeds a default `distribution` (display once, no triggers, no targeting) that you finish configuring before publishing. Prompt text is sent to the configured AI provider for generation, but it is not stored by this endpoint, not logged by default, and not included in audit data. **Feedback Records** `/api/v3/feedbackRecords` is served by the **API gateway** (Envoy on Formbricks Cloud, Traefik in the one-click Docker install), which authorizes each call against the dataset and forwards it to the feedback store — not by the application routes that serve the rest of v3. Three consequences: the payload is the store's own, so members and filters are **`snake_case`** (`tenant_id`, `value_text`) rather than v3's camelCase; the dataset is named **`tenant_id`** on the wire and is required on every collection operation (it is the feedback dataset id, which the MCP `list_feedback_datasets` tool reports as `dataset_id`); and errors come in two shapes — gateway refusals (**400**, **401**, **403**, **413**, **503**) are `text/plain`, while the store's own problems are `application/problem+json` with a stable `code`. These eight operations are the whole of the gateway-served surface; any other path it receives under the prefix answers **400**. Authenticate with **`x-api-key`**: the key needs a permission on a workspace the dataset is assigned to — `read` to list, get and search, `write` to create and update, `manage` to delete — and may update or delete only in a dataset assigned to exactly one workspace. **OpenAPI** This spec is **not** produced by `pnpm generate-api-specs` (that script only builds v2 → `docs/api-v2-reference/openapi.yml`). When the route contract changes, edit the files under `docs/api-v3-reference/src/`, then run `pnpm api:v3:bundle` to regenerate the committed single-file bundle. `pnpm api:v3:lint` lints the source tree; `pnpm api:v3:check` (CI) fails when the bundle is stale. **Workflows Scope 1** Workflows are a follow-up extension of the existing v3 Survey API work. The Survey API establishes API-first survey authoring; Workflows build on that same v3 style to automate actions around survey responses through workspace-scoped JSON definitions. Scope 1 models the existing Follow-ups capability as workflows: one `response.completed` trigger with an optional `endingCardIds` filter, and `send_email` actions with Follow-up email field parity. The definition and run shapes mirror the shared Zod schemas in `packages/workflows` (ENG-1100), which are the implementation source of truth for this contract. Workflows use `draft`, `enabled`, and `disabled` lifecycle states plus an `archived` soft-delete state. Status only changes through the lifecycle endpoints (`enable`, `disable`, `archive`, `unarchive`); it is not writable via `POST` or `PATCH`. Enabling validates that the definition is executable and snapshots an immutable workflow version; runs reference that snapshot via `workflowVersionId`. `POST .../test` is a dry run: it validates the definition and resolves the trigger's references synchronously, creating no run and sending no email, and returns `{ workflowId, ok, problems }` directly. Real runs execute asynchronously and are polled via `GET /api/v3/workflows/runs/{runId}`. **Overview migration note** The v3-backed survey overview page intentionally removes actions that are not yet exposed by this contract: `Created by` filtering, `Duplicate`, `Copy...`, `Preview`, and `Copy link`. **Next steps (out of scope for this spec)** Optional ETag/304, field selection, translation-specific writes, and survey version history. version: 0.2.0 x-implementation-notes: route: apps/web/app/api/v3/surveys/route.ts generate-route: apps/web/app/api/v3/surveys/generate/route.ts query-parser: apps/web/app/api/v3/surveys/parse-v3-surveys-list-query.ts auth: apps/web/app/api/v3/lib/auth.ts workspace-resolution: apps/web/app/api/v3/lib/workspace-context.ts workflow-contract-ticket: ENG-1101 workflow-shared-schemas: packages/workflows/src/types (feat/workflows-types) workflow-prisma-schema: packages/database/schema/workflows.prisma (feat/workflows-prisma-schema) openapi-generated: false spec-source: docs/api-v3-reference/src (regenerate bundle with `pnpm api:v3:bundle`) responses-contract-ticket: ENG-2868 responses-rfc: v3 Responses API RFC sections 2b (resource) and 2c (endpoints) responses-stored-shape: packages/types/responses.ts (ZResponse, ZResponseData, ZResponseInput) responses-prisma-model: packages/database/schema/main.prisma (model Response) pagination-model: cursor cursor-pagination: supported servers: - url: https://app.formbricks.com description: >- Formbricks Cloud. Paths in this spec already include the `/api/v3` prefix; self-hosted instances substitute their own origin. security: [] paths: /api/v3/surveys/generate: post: tags: - V3 Surveys summary: Create a survey draft payload with AI description: > Creates a strict v3 `POST /api/v3/surveys` create payload from a creator prompt and returns validation metadata. This endpoint is single-purpose: it does **not** persist the survey. Clients should validate the returned payload with `/api/v3/surveys/validate` or use the embedded validation metadata, then create the draft through `POST /api/v3/surveys`. The generated payload always sets `status: draft`. Both `type: link` and `type: app` are supported; for `app`, the payload includes a default `distribution` (display once, no triggers, no targeting) that you finish configuring in the editor or via the create request. Prompt privacy: prompt text is sent to the configured AI provider to create the payload, but this endpoint does not store prompts and server logs should use request ids and failure categories instead of raw prompt content. operationId: generateSurveyV3 requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GenerateSurveyRequest' examples: onboarding: summary: Create a link survey draft value: workspaceId: clxx1234567890123456789012 type: link language: en-US prompt: >- Understand why new users stop during onboarding and what would help them finish setup. responses: '200': description: >- Survey create payload generated successfully. The survey has not been created yet. headers: X-Request-Id: schema: type: string description: Request correlation ID Cache-Control: schema: type: string example: private, no-store content: application/json: schema: type: object required: - data properties: data: $ref: '#/components/schemas/GenerateSurveyResult' examples: generated: summary: Generated draft create payload value: data: language: en-US payload: workspaceId: clxx1234567890123456789012 type: link name: Onboarding Completion Survey status: draft defaultLanguage: en-US languages: - code: en-US default: true enabled: true metadata: title: en-US: Onboarding Completion Survey welcomeCard: enabled: false blocks: - id: clbk1234567890123456789012 name: Main elements: - id: q_1_example type: openText headline: en-US: What made onboarding hard to complete? required: false isDraft: true inputType: text longAnswer: false charLimit: enabled: false endings: - id: clen1234567890123456789012 type: endScreen headline: en-US: Thanks for your feedback hiddenFields: enabled: false variables: [] validation: valid: true invalid_params: [] languages: - code: en-US default: true enabled: true '400': description: Malformed body or a prompt that is too short or underspecified content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: shortPrompt: summary: Prompt needs more detail value: title: Bad Request status: 400 detail: Prompt needs more detail code: bad_request requestId: req_123 invalid_params: - name: prompt reason: >- Describe the survey goal, audience, or topic in a sentence so the AI can create a useful draft. '401': $ref: '#/components/responses/V3Unauthorized' '403': description: >- Forbidden — no write access, workspace does not exist, AI is not in plan, or AI smart tools are disabled content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: noWorkspaceWriteAccess: summary: No workspace write access value: title: Forbidden status: 403 detail: You are not authorized to access this resource code: forbidden requestId: req_123 aiDisabled: summary: AI smart tools disabled value: title: Forbidden status: 403 detail: AI smart tools are disabled for this organization. code: ai_smart_tools_disabled requestId: req_123 aiNotInPlan: summary: AI features not enabled for the plan value: title: Forbidden status: 403 detail: AI smart tools are not available for this organization. code: ai_features_not_enabled requestId: req_123 '422': description: >- AI generated an invalid payload after schema and v3 create validation, or the generation stopped because the output token limit was reached content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: invalidGeneratedPayload: summary: Invalid generated payload value: title: Unprocessable Content status: 422 detail: >- Generated survey payload is invalid: generatedSurvey.blocks: Too small code: ai_generated_payload_invalid requestId: req_123 invalid_params: - name: generatedSurvey.blocks reason: Too small aiOutputTooLong: summary: Output token limit reached value: title: Unprocessable Content status: 422 detail: >- The generated survey exceeded the AI output token limit. Simplify the prompt or split it into smaller surveys. code: ai_output_too_long requestId: req_123 '429': $ref: '#/components/responses/V3TooManyRequests' '500': $ref: '#/components/responses/V3InternalServerError' '502': description: The configured AI provider failed or could not produce a valid draft content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: providerFailed: summary: AI provider failed value: title: Bad Gateway status: 502 detail: >- The AI provider could not generate a valid survey draft. Try again or add more detail. code: bad_gateway requestId: req_123 providerAuthFailed: summary: AI provider rejected the instance's credentials value: title: Bad Gateway status: 502 detail: >- The AI provider rejected this instance's credentials. Ask your administrator to check the AI provider configuration. code: ai_provider_auth_failed requestId: req_123 '503': description: AI is not configured on this Formbricks instance content: application/problem+json: schema: $ref: '#/components/schemas/Problem' examples: instanceNotConfigured: summary: AI instance configuration missing value: title: Service Unavailable status: 503 detail: AI is not configured for this Formbricks instance. code: ai_instance_not_configured requestId: req_123 security: - sessionAuth: [] - apiKeyAuth: [] - bearerAuth: [] components: schemas: GenerateSurveyRequest: type: object description: > AI survey creation request. `prompt` is used only to create a draft payload; it is not persisted by this endpoint. The generated payload is validated and returned to the caller for a separate create request. required: - workspaceId - prompt properties: workspaceId: type: string format: cuid2 description: >- Workspace where the AI-created survey draft would be created. Requires read/write access. prompt: type: string minLength: 4 maxLength: 1200 description: > Natural-language survey goal and audience. Prompts with fewer than 24 characters or fewer than four whitespace-separated words return prompt feedback before any AI provider call. type: type: string enum: - link - app default: link description: >- Survey type to generate. The AI generates the survey content (blocks/questions) for both types; for `app` it additionally seeds a default `distribution` (display once, no triggers, no targeting) that you finish configuring before publishing. language: $ref: '#/components/schemas/AISurveyGenerationLocaleCode' description: > Preferred survey language. Session clients should send the logged-in user's language. The generator uses it when the prompt language is ambiguous or cannot be confidently matched to a supported app locale. additionalProperties: false GenerateSurveyResult: type: object required: - language - payload - validation properties: language: $ref: '#/components/schemas/AISurveyGenerationLocaleCode' description: >- Supported app locale used for the AI-created survey content and create payload language maps. payload: allOf: - $ref: '#/components/schemas/CreateSurveyRequest' description: > Strict create payload ready for `POST /api/v3/surveys`. It always has `status: draft`. validation: $ref: '#/components/schemas/GeneratedSurveyValidationResult' additionalProperties: false Problem: type: object description: >- RFC 9457 Problem Details for HTTP APIs (`application/problem+json`). Responses typically include a machine-readable `code` field alongside `title`, `status`, `detail`, and `requestId`. Branch on `code`, not on `detail` or `title`: `code` is stable and locale-independent, whereas `detail` is prose that may be reworded. No problem sets `type`, so per RFC 9457 §4.2.1 `title` is always the HTTP reason phrase for `status` and carries no information of its own. Member naming is frozen as published, mixed conventions included (`requestId` alongside `invalid_params` and `details.resource_type`): renaming any of them would break every client that reads them. required: - title - status - detail - requestId properties: type: type: string format: uri title: type: string status: type: integer detail: type: string instance: type: string code: type: string enum: - ai_features_not_enabled - ai_generated_payload_invalid - ai_instance_not_configured - ai_output_too_long - ai_provider_auth_failed - ai_smart_tools_disabled - bad_gateway - bad_request - conflict - custom_css_plan_required - forbidden - internal_server_error - invalid_workflow_state - not_authenticated - not_found - payload_too_large - projection_pending - service_unavailable - stored_survey_invalid - survey_not_workspace_visible - too_many_requests - unprocessable_content - visibility_blocked_by_connections - visibility_change_not_allowed - visibility_not_enabled - workflow_not_executable - workspace_survey_limit_reached requestId: type: string details: type: object invalid_params: type: array items: $ref: '#/components/schemas/InvalidParam' AISurveyGenerationLocaleCode: type: string enum: - de-DE - en-US - es-ES - fr-FR - hu-HU - ja-JP - nl-NL - pt-BR - pt-PT - ro-RO - ru-RU - sv-SE - tr-TR - zh-Hans-CN - zh-Hant-TW description: Supported app locale code that AI survey creation can return. example: en-US CreateSurveyRequest: type: object description: > Strict v3 survey creation document. This endpoint accepts survey structure only: name, metadata, languages and language settings, welcome card, blocks/elements/logic, endings, hidden fields, and variables. App surveys (`type: app`) additionally accept the `distribution` (display options + triggers) and `targeting` (contact segment filters) objects; these are rejected for `link` surveys. It rejects legacy `questions` and out-of-scope settings such as styling, follow-ups, recaptcha, single-use/email verification, slug, custom scripts, analytics fields, timestamps, and `createdBy`. Translatable fields use real locale-code maps. The map must include the canonical `defaultLanguage` key, such as `en-US`, so the server can persist the internal default translation. Locale keys must be canonical BCP 47 codes such as `de-DE`, `pt-PT`, or `zh-Hans-CN`. Non-default locale keys must be declared in `languages`; undeclared locale keys in metadata, welcome cards, blocks, or endings are rejected with `unsupported_locale`. `blocks[].id` and `variables[].id` may be omitted on create and will be generated by the server. Provide explicit cuid2 ids when other fields in the same request reference them. For normal sequential flow, omit `logicFallback`. It is only valid together with a non-empty `logic` array on the same block. required: - workspaceId - name - blocks properties: workspaceId: type: string format: cuid2 description: >- Workspace where the survey will be created. Requires read/write access. name: type: string minLength: 1 type: type: string enum: - link - app default: link description: > Survey type. `link` surveys are distributed by URL; `app` surveys are shown in-app and configure their runtime behavior via the `distribution` and `targeting` objects. `type` is immutable after creation (it cannot be changed via PATCH). status: type: string enum: - draft - inProgress - paused - completed default: draft metadata: allOf: - $ref: '#/components/schemas/SurveyMetadata' default: {} defaultLanguage: allOf: - $ref: '#/components/schemas/LocaleCode' default: en-US description: >- Default authoring locale. Translatable maps must include this locale key. languages: type: array default: [] maxItems: 50 items: $ref: '#/components/schemas/CreateSurveyLanguage' description: > Optional survey language configuration. Every non-default locale used by translatable maps must be declared here; omitted languages are not inferred from map keys. showLanguageSwitch: type: - boolean - 'null' default: null description: >- Show respondents a language switch on multi-language surveys. `null` and `false` both mean off. autoSelectLanguage: type: - boolean - 'null' default: null description: >- Open link and app surveys in the respondent's browser language when it matches an enabled survey language; otherwise the default language is used. `null` and `false` both mean off. welcomeCard: allOf: - $ref: '#/components/schemas/SurveyWelcomeCard' default: enabled: false blocks: type: array minItems: 1 maxItems: 1000 items: $ref: '#/components/schemas/CreateSurveyBlock' endings: type: array default: [] maxItems: 100 items: $ref: '#/components/schemas/SurveyEnding' hiddenFields: allOf: - $ref: '#/components/schemas/SurveyHiddenFields' default: enabled: false variables: type: array default: [] maxItems: 100 items: $ref: '#/components/schemas/CreateSurveyVariable' distribution: allOf: - $ref: '#/components/schemas/SurveyDistribution' description: >- App-survey runtime/display settings. Only valid when `type` is `app`. targeting: allOf: - $ref: '#/components/schemas/SurveyTargeting' description: App-survey contact targeting. Only valid when `type` is `app`. customCss: anyOf: - $ref: '#/components/schemas/CustomCssInput' - type: 'null' description: >- Optional survey custom CSS source. Processed by the server; constructs it removes come back as top-level `warnings` on the 201. Adding CSS needs the Scale plan on Formbricks Cloud (403 `custom_css_plan_required`); CSS that cannot be processed is a 422 with `details.errors`. Processing counts against the custom CSS budget of 60 per minute per user or API key, shared with custom CSS validation; beyond it the create is a 429 and nothing is written. additionalProperties: false GeneratedSurveyValidationResult: type: object required: - valid - invalid_params - languages properties: valid: type: boolean description: >- Whether the generated create payload passed the same v3 create preparation pipeline. invalid_params: type: array description: >- Repairable validation errors. Successful generate responses return an empty array. items: $ref: '#/components/schemas/InvalidParam' languages: type: array description: Languages that the generated create payload would connect or create. items: $ref: '#/components/schemas/GeneratedSurveyValidationLanguage' additionalProperties: false InvalidParam: type: object description: > Field-level validation error. `name` and `reason` are always intended for humans. Optional machine-readable fields are included when the API can identify the semantic error, especially for survey locale, identifier, and reference validation used by MCP and agent clients. required: - name - reason properties: name: type: string description: Dot-path to the invalid request field. reason: type: string description: Human-readable repair guidance. code: type: string enum: - dangling_reference - duplicate_identifier - duplicate_locale - forbidden_identifier - immutable_identifier - invalid_locale - invalid_reference - missing_required_field - misordered_reference - missing_translation - qsf_limit_exceeded - qsf_not_recognized - read_only_field - unsupported_field - unsupported_locale description: > Machine-readable validation category, when available. This is the shared error shape every v3 operation returns, so it lists what the API can emit today and nothing more — `INVALID_PARAM_CODES` in `app/api/v3/lib/response.ts` is the registry, and a code absent from it is dropped before the response is built. Categories for operations that do not exist yet are added with the code that emits them, not ahead of it. `qsf_not_recognized` and `qsf_limit_exceeded` come from the Qualtrics import (an internal, session-only route sharing this shape): the file is not a Qualtrics export it can read, or it is one past an import limit, which `identifier` names. identifier: type: string description: >- Identifier involved in the validation failure, when available. For language errors, this can be the normalized language code. referenceType: type: string enum: - block - element - ending - hiddenField - language - variable - variableName - recall description: >- Identifier namespace involved in the validation failure. Same rule as `code`: these are the namespaces the API emits today, and more arrive with the operations that emit them. missingId: type: string description: Referenced id that does not exist in the submitted survey document. firstUsedAt: type: string description: Dot-path where a duplicate identifier was first used. conflictsWith: type: string description: Dot-path to the existing identifier that conflicts with this field. additionalProperties: false SurveyMetadata: type: object description: > Arbitrary JSON survey context for customer- or operation-specific metadata. v3 preserves arbitrary metadata values as-is. If present, `title` and `description` are treated as translatable text maps and returned with real locale-code keys. properties: title: $ref: '#/components/schemas/TranslatableText' description: $ref: '#/components/schemas/TranslatableText' additionalProperties: true LocaleCode: type: string pattern: ^[a-z]{2}(?:-[A-Z][a-z]{3})?-[A-Z]{2}$ description: >- Canonical locale code accepted by v3 survey APIs, for example `en-US`, `de-DE`, or `zh-Hans-CN`. example: en-US CreateSurveyLanguage: type: object description: >- Language to connect to the created survey. `default`, if provided, must match `defaultLanguage`. required: - code properties: code: $ref: '#/components/schemas/LocaleCode' default: type: boolean description: >- Optional marker for readability; only the `defaultLanguage` entry may set this to true. enabled: type: boolean default: true description: Whether this language is enabled for respondent-facing delivery. additionalProperties: false SurveyWelcomeCard: type: object description: Optional card shown before the first survey block. required: - enabled properties: enabled: type: boolean headline: $ref: '#/components/schemas/TranslatableText' subheader: $ref: '#/components/schemas/TranslatableText' buttonLabel: $ref: '#/components/schemas/TranslatableText' fileUrl: type: string videoUrl: type: string timeToFinish: type: boolean showResponseCount: type: boolean additionalProperties: false CreateSurveyBlock: type: object description: > Block accepted by `POST /api/v3/surveys`. `id` may be omitted and will be generated by the server. Provide an explicit cuid2 id when logic in the same request needs to jump to this block. For normal sequential flow, omit `logic` and `logicFallback`. `logicFallback` is only valid when this same block has at least one `logic` rule. required: - name - elements properties: id: type: string format: cuid2 description: Optional stable block id. Generated when omitted. name: type: string minLength: 1 elements: type: array minItems: 1 items: $ref: '#/components/schemas/SurveyElement' logic: type: array items: $ref: '#/components/schemas/SurveyBlockLogic' logicFallback: type: string format: cuid2 description: > Block or ending id used when no logic condition matches. Only valid when this same block has at least one `logic` rule; omit it for normal sequential flow. buttonLabel: $ref: '#/components/schemas/TranslatableText' backButtonLabel: $ref: '#/components/schemas/TranslatableText' additionalProperties: false SurveyEnding: oneOf: - $ref: '#/components/schemas/SurveyEndScreenEnding' - $ref: '#/components/schemas/SurveyRedirectEnding' discriminator: propertyName: type mapping: endScreen: '#/components/schemas/SurveyEndScreenEnding' redirectToUrl: '#/components/schemas/SurveyRedirectEnding' description: > Ending reached after the last block or a jump action. `type` selects the allowed shape; unsupported fields are rejected instead of ignored. SurveyHiddenFields: type: object description: > Hidden fields, sometimes called embedded data in other survey products. Field ids are stable public identifiers and may be referenced by logic, recall, quotas, integrations, and response data. **Naming rule for new field ids** — the same rule the survey editor applies (ENG-2539): a new id must start with a lowercase letter and then contain only lowercase letters, numbers and underscores (`^[a-z][a-z0-9_]*$`), and must not take a reserved name. Reserved are the link-survey system params and internal ids — `userId`, `source`, `suid`, `end`, `start`, `welcomeCard`, `hidden`, `verifiedEmail`, `multiLanguage`, `embed`, `verify`, `suToken`, `lang`, `preview`, `startAt`, `skipPrefilled`, `offlineSupport` (matched case-insensitively) — and the names of auto-captured system fields, which every survey can already read without declaring them: `source`, `url`, `country`, `action`, `browser`, `os`, `deviceType`, `ipAddress`, `finished`, `language`, `locale`, `responseId`, `surveyId`, `durationSeconds`, `startedAt`, `finishedAt`, `pagePath`, `pageReferrer`, `utmSource`, `utmMedium`, `utmCampaign`, `utmTerm`, `utmContent`, `screenWidth`, `screenHeight`, `viewportWidth`, `viewportHeight`, `timezone`. **Ids a survey already declares are grandfathered**: they always load, and re-sending the survey unchanged never fails validation — only *adding* such a name as a new field is refused. Deleting a grandfathered field spends the reprieve: once it is gone from the saved survey, the name can no longer be re-added. Note this means re-creating a survey from an exported document can fail with a 400 when the export declares a name the rule refuses; rename the field in the payload before importing. The `pattern` below describes what stored surveys may hold (the pre-existing lenient charset), not what a new id may look like. required: - enabled properties: enabled: type: boolean description: > Derived, not stored: `true` whenever the survey declares at least one hidden field. A value sent on create or update is ignored; to turn hidden fields off, remove them from `fieldIds`. fieldIds: type: array maxItems: 200 items: type: string pattern: ^[a-zA-Z0-9_-]+$ uniqueItems: true additionalProperties: false CreateSurveyVariable: oneOf: - $ref: '#/components/schemas/CreateSurveyNumberVariable' - $ref: '#/components/schemas/CreateSurveyTextVariable' description: > Survey variable accepted by `POST /api/v3/surveys`. `id` may be omitted and will be generated by the server. Provide an explicit cuid2 id when logic in the same request needs to reference this variable. SurveyDistribution: type: object description: > App-survey runtime/display settings. Only valid for `type: app`; rejected for link surveys. **Replacement semantics (destructive):** when `distribution` is provided on PATCH it fully replaces the stored object — any sub-field you omit is reset to its default, NOT preserved. In particular, omitting `triggers` removes ALL existing triggers, and omitting `displayOption` resets it to `displayOnce`. To change one setting, send the complete desired distribution. To leave distribution untouched, omit the whole `distribution` key. properties: displayOption: type: string enum: - displayOnce - displayMultiple - respondMultiple - displaySome default: displayOnce description: > How often the survey may be shown to a contact. `displaySome` shows it up to `displayLimit` times (or until the contact responds, whichever comes first). displayPercentage: type: - number - 'null' minimum: 0.01 maximum: 100 default: null description: > Independent throttle: show the survey to only this percentage of triggered contacts. Optional and valid with any `displayOption`; null/omitted means no throttle (shown to everyone). displayLimit: type: - integer - 'null' minimum: 0 default: null description: > Maximum number of times the survey is shown to a single contact. Required (must be >= 1) when `displayOption` is `displaySome`; otherwise optional. recontactDays: type: - integer - 'null' minimum: 0 default: null description: >- Days to wait before showing this survey again to the same contact. Null uses the workspace default. autoClose: type: - integer - 'null' minimum: 0 default: null description: >- Seconds of inactivity after which the survey widget auto-closes. Null disables auto-close. autoComplete: type: - integer - 'null' minimum: 1 default: null description: >- Automatically stop collecting responses after this many completed responses. Null disables it. delay: type: integer minimum: 0 default: 0 description: Seconds to wait after a trigger fires before showing the survey. triggers: type: array default: [] maxItems: 50 items: $ref: '#/components/schemas/SurveyTrigger' description: > Action classes that trigger the survey. Every id must reference an existing workspace action class. On PATCH this list fully replaces the survey's triggers — omitting it (or sending `[]`) removes all existing triggers. additionalProperties: false example: displayOption: displaySome displayLimit: 3 displayPercentage: null recontactDays: 7 autoClose: null autoComplete: null delay: 0 triggers: - actionClassId: clyy1234567890123456789012 SurveyTargeting: type: object description: > App-survey contact targeting. Only valid for `type: app`. `filters: []` targets everyone. Setting or changing non-empty filters requires the Contacts entitlement; otherwise create/patch returns 403. `attribute` filters reference workspace contact-attribute keys (discover them via `GET /api/v3/contact-attribute-keys`) and `segment` filters reference other segment ids — both are workspace-scoped resources you must obtain before constructing filters (an invalid key/id targets no one rather than erroring). See `SegmentFilter` for the per-`root.type` operator sets. required: - filters properties: filters: $ref: '#/components/schemas/SegmentFilters' additionalProperties: false CustomCssInput: type: object description: >- Custom CSS **source** as a caller writes it (ENG-3641). Both keys are required. `light` is base CSS that applies in both appearances; `dark` adds overrides on top of it when the survey renders dark. `null`, an empty string or whitespace means "no CSS" for that field. Source only: compiled output and the processor version are computed by the server on every write, and a request that supplies either is rejected. The combined source is limited to 100 000 UTF-8 bytes for a workspace and 20 000 for a survey; larger CSS is a **422** with error code `source_too_large`. required: - light - dark properties: light: type: - string - 'null' description: Base CSS, applied in light and dark appearance. dark: type: - string - 'null' description: Additional CSS applied only in dark appearance. additionalProperties: false GeneratedSurveyValidationLanguage: type: object required: - code - default - enabled properties: code: $ref: '#/components/schemas/AISurveyGenerationLocaleCode' default: type: boolean enabled: type: boolean additionalProperties: false TranslatableText: allOf: - $ref: '#/components/schemas/TranslatableTextMap' description: > Survey authoring text. `GET /api/v3/surveys/{surveyId}` always returns maps keyed by the emitted `languages[].code` values for this survey. Use `?lang=` to filter which language keys are included. The internal storage key `default` is never exposed by v3. examples: - en-US: What should we improve? de-DE: Was sollten wir verbessern? SurveyElement: oneOf: - $ref: '#/components/schemas/SurveyOpenTextElement' - $ref: '#/components/schemas/SurveyConsentElement' - $ref: '#/components/schemas/SurveyMultipleChoiceSingleElement' - $ref: '#/components/schemas/SurveyMultipleChoiceMultiElement' - $ref: '#/components/schemas/SurveyNpsElement' - $ref: '#/components/schemas/SurveyCtaElement' - $ref: '#/components/schemas/SurveyRatingElement' - $ref: '#/components/schemas/SurveyPictureSelectionElement' - $ref: '#/components/schemas/SurveyDateElement' - $ref: '#/components/schemas/SurveyFileUploadElement' - $ref: '#/components/schemas/SurveyCalElement' - $ref: '#/components/schemas/SurveyMatrixElement' - $ref: '#/components/schemas/SurveyAddressElement' - $ref: '#/components/schemas/SurveyRankingElement' - $ref: '#/components/schemas/SurveyContactInfoElement' - $ref: '#/components/schemas/SurveyCsatElement' - $ref: '#/components/schemas/SurveyCesElement' discriminator: propertyName: type mapping: openText: '#/components/schemas/SurveyOpenTextElement' consent: '#/components/schemas/SurveyConsentElement' multipleChoiceSingle: '#/components/schemas/SurveyMultipleChoiceSingleElement' multipleChoiceMulti: '#/components/schemas/SurveyMultipleChoiceMultiElement' nps: '#/components/schemas/SurveyNpsElement' cta: '#/components/schemas/SurveyCtaElement' rating: '#/components/schemas/SurveyRatingElement' pictureSelection: '#/components/schemas/SurveyPictureSelectionElement' date: '#/components/schemas/SurveyDateElement' fileUpload: '#/components/schemas/SurveyFileUploadElement' cal: '#/components/schemas/SurveyCalElement' matrix: '#/components/schemas/SurveyMatrixElement' address: '#/components/schemas/SurveyAddressElement' ranking: '#/components/schemas/SurveyRankingElement' contactInfo: '#/components/schemas/SurveyContactInfoElement' csat: '#/components/schemas/SurveyCsatElement' ces: '#/components/schemas/SurveyCesElement' description: > Survey element/question inside a block. Element ids are stable public identifiers used by logic, recall strings, response data, quotas, integrations, and analysis. `type` selects the allowed shape; unsupported fields are rejected instead of ignored. SurveyBlockLogic: type: object description: Conditional logic rule evaluated at block level. required: - id - conditions - actions properties: id: type: string format: cuid2 conditions: $ref: '#/components/schemas/SurveyConditionGroup' actions: type: array items: $ref: '#/components/schemas/SurveyLogicAction' additionalProperties: false SurveyEndScreenEnding: type: object description: Visual end screen displayed after survey completion. required: - id - type properties: id: type: string format: cuid2 description: Stable ending id. `jumpToBlock.target` may point to this id. type: type: string enum: - endScreen headline: $ref: '#/components/schemas/TranslatableText' subheader: $ref: '#/components/schemas/TranslatableText' buttonLabel: $ref: '#/components/schemas/TranslatableText' buttonLink: type: string imageUrl: type: string imageAltText: allOf: - $ref: '#/components/schemas/TranslatableText' description: >- Text alternative for `imageUrl`, read by screen readers. Omit or leave empty for a decorative image (rendered as `alt=""`). videoUrl: type: string hideDefaultIcon: type: boolean description: >- Hides the default checkmark icon rendered above the headline when the ending carries no image or video. Omit to keep the icon. additionalProperties: false SurveyRedirectEnding: type: object description: > Redirects the respondent to a URL after survey completion. External redirects require the organization's external URL permission; otherwise write endpoints return `403 Forbidden`. required: - id - type - url properties: id: type: string format: cuid2 description: Stable ending id. `jumpToBlock.target` may point to this id. type: type: string enum: - redirectToUrl url: type: string format: uri description: >- External redirect URL. Requires the organization's external URL permission. label: type: string description: Optional internal label for redirect endings. additionalProperties: false CreateSurveyNumberVariable: type: object required: - name - type - value properties: id: type: string format: cuid2 description: Optional stable variable id. Generated when omitted. name: type: string pattern: ^[a-z][a-z0-9_]*$ description: > Unique variable name. Must start with a lowercase letter, then lowercase letters, numbers and underscores only — the same rule as new hidden-field ids (this schema is create-only, so no grandfathered name validates against it). Reserved names are refused: `userId`, `source`, `suid`, `end`, `start`, `welcomeCard`, `hidden`, `verifiedEmail`, `multiLanguage`, `embed`, `verify`, `suToken`, `lang`, `preview`, `startAt`, `skipPrefilled`, `offlineSupport`, and the auto-captured system field names `source`, `url`, `country`, `action`, `browser`, `os`, `deviceType`, `ipAddress`, `finished`, `language`, `locale`, `responseId`, `surveyId`, `durationSeconds`, `startedAt`, `finishedAt`, `pagePath`, `pageReferrer`, `utmSource`, `utmMedium`, `utmCampaign`, `utmTerm`, `utmContent`, `screenWidth`, `screenHeight`, `viewportWidth`, `viewportHeight`, `timezone`. type: type: string enum: - number value: type: number description: Default numeric value. additionalProperties: false CreateSurveyTextVariable: type: object required: - name - type - value properties: id: type: string format: cuid2 description: Optional stable variable id. Generated when omitted. name: type: string pattern: ^[a-z][a-z0-9_]*$ description: > Unique variable name. Must start with a lowercase letter, then lowercase letters, numbers and underscores only — the same rule as new hidden-field ids (this schema is create-only, so no grandfathered name validates against it). Reserved names are refused: `userId`, `source`, `suid`, `end`, `start`, `welcomeCard`, `hidden`, `verifiedEmail`, `multiLanguage`, `embed`, `verify`, `suToken`, `lang`, `preview`, `startAt`, `skipPrefilled`, `offlineSupport`, and the auto-captured system field names `source`, `url`, `country`, `action`, `browser`, `os`, `deviceType`, `ipAddress`, `finished`, `language`, `locale`, `responseId`, `surveyId`, `durationSeconds`, `startedAt`, `finishedAt`, `pagePath`, `pageReferrer`, `utmSource`, `utmMedium`, `utmCampaign`, `utmTerm`, `utmContent`, `screenWidth`, `screenHeight`, `viewportWidth`, `viewportHeight`, `timezone`. type: type: string enum: - text value: type: string description: Default text value. additionalProperties: false SurveyTrigger: type: object description: > Reference to an existing workspace action class that triggers this app survey. Discover available action-class ids with `GET /api/v3/action-classes`. required: - actionClassId properties: actionClassId: type: string format: cuid2 description: Id of an action class in the same workspace. additionalProperties: false SegmentFilters: type: array description: > Contact targeting filter tree. An empty array targets everyone. Each node joins the previous one via its `connector` (`and`/`or`; the first node's connector is null). A node's `resource` is either a single filter condition or a nested filter group (enabling parenthesized `and`/`or` logic). items: type: object required: - id - connector - resource properties: id: type: string format: cuid2 connector: type: - string - 'null' enum: - and - or - null description: >- Logical connector joining this node to the previous one. Null for the first node. resource: oneOf: - $ref: '#/components/schemas/SegmentFilter' - $ref: '#/components/schemas/SegmentFilters' description: >- A single filter condition, or a nested filter group for grouped logic. additionalProperties: false TranslatableTextMap: type: object description: >- Multilingual text map keyed by the emitted `languages[].code` values for this survey. propertyNames: type: string description: >- Survey language code/tag, for example `en-US`, `de-DE`, or `zh-Hans-CN`. additionalProperties: type: string SurveyOpenTextElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object properties: type: type: string enum: - openText placeholder: $ref: '#/components/schemas/TranslatableText' longAnswer: type: boolean inputType: type: string enum: - text - email - url - number - phone default: text insightsEnabled: type: boolean default: false charLimit: $ref: '#/components/schemas/SurveyCharLimit' validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyConsentElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - label properties: type: type: string enum: - consent label: $ref: '#/components/schemas/TranslatableText' validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyMultipleChoiceSingleElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - choices properties: type: type: string enum: - multipleChoiceSingle choices: type: array minItems: 2 items: $ref: '#/components/schemas/SurveyChoice' shuffleOption: $ref: '#/components/schemas/SurveyShuffleOption' otherOptionPlaceholder: $ref: '#/components/schemas/TranslatableText' displayType: $ref: '#/components/schemas/SurveyMultipleChoiceDisplayType' unevaluatedProperties: false SurveyMultipleChoiceMultiElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - choices properties: type: type: string enum: - multipleChoiceMulti choices: type: array minItems: 2 items: $ref: '#/components/schemas/SurveyChoice' shuffleOption: $ref: '#/components/schemas/SurveyShuffleOption' otherOptionPlaceholder: $ref: '#/components/schemas/TranslatableText' validation: $ref: '#/components/schemas/SurveyValidation' displayType: $ref: '#/components/schemas/SurveyMultipleChoiceDisplayType' unevaluatedProperties: false SurveyNpsElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object properties: type: type: string enum: - nps lowerLabel: $ref: '#/components/schemas/TranslatableText' upperLabel: $ref: '#/components/schemas/TranslatableText' isColorCodingEnabled: type: boolean default: false unevaluatedProperties: false SurveyCtaElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object description: >- If `buttonExternal` is true, `buttonUrl` and `ctaButtonLabel` are required. properties: type: type: string enum: - cta buttonExternal: type: boolean default: false buttonUrl: type: string ctaButtonLabel: $ref: '#/components/schemas/TranslatableText' - if: required: - buttonExternal properties: buttonExternal: const: true then: required: - buttonUrl - ctaButtonLabel unevaluatedProperties: false SurveyRatingElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - scale - range properties: type: type: string enum: - rating scale: type: string enum: - number - smiley - star range: type: integer enum: - 3 - 4 - 5 - 6 - 7 - 10 lowerLabel: $ref: '#/components/schemas/TranslatableText' upperLabel: $ref: '#/components/schemas/TranslatableText' isColorCodingEnabled: type: boolean default: false unevaluatedProperties: false SurveyPictureSelectionElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - choices properties: type: type: string enum: - pictureSelection allowMulti: type: boolean default: false choices: type: array minItems: 2 items: $ref: '#/components/schemas/SurveyPictureChoice' validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyDateElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - format properties: type: type: string enum: - date html: $ref: '#/components/schemas/TranslatableText' format: type: string enum: - M-d-y - d-M-y - y-M-d validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyFileUploadElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - allowMultipleFiles properties: type: type: string enum: - fileUpload allowMultipleFiles: type: boolean maxSizeInMB: type: number allowedFileExtensions: type: array items: type: string validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyCalElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - calUserName properties: type: type: string enum: - cal calUserName: type: string minLength: 1 calHost: type: string unevaluatedProperties: false SurveyMatrixElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - rows - columns properties: type: type: string enum: - matrix rows: type: array items: $ref: '#/components/schemas/SurveyChoice' columns: type: array items: $ref: '#/components/schemas/SurveyChoice' shuffleOption: $ref: '#/components/schemas/SurveyShuffleOption' validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyAddressElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - addressLine1 - addressLine2 - city - state - zip - country properties: type: type: string enum: - address addressLine1: $ref: '#/components/schemas/SurveyToggleInputConfig' addressLine2: $ref: '#/components/schemas/SurveyToggleInputConfig' city: $ref: '#/components/schemas/SurveyToggleInputConfig' state: $ref: '#/components/schemas/SurveyToggleInputConfig' zip: $ref: '#/components/schemas/SurveyToggleInputConfig' country: $ref: '#/components/schemas/SurveyToggleInputConfig' validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyRankingElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - choices properties: type: type: string enum: - ranking choices: type: array minItems: 2 maxItems: 25 items: $ref: '#/components/schemas/SurveyChoice' otherOptionPlaceholder: $ref: '#/components/schemas/TranslatableText' shuffleOption: $ref: '#/components/schemas/SurveyShuffleOption' validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyContactInfoElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - firstName - lastName - email - phone - company properties: type: type: string enum: - contactInfo firstName: $ref: '#/components/schemas/SurveyToggleInputConfig' lastName: $ref: '#/components/schemas/SurveyToggleInputConfig' email: $ref: '#/components/schemas/SurveyToggleInputConfig' phone: $ref: '#/components/schemas/SurveyToggleInputConfig' company: $ref: '#/components/schemas/SurveyToggleInputConfig' validation: $ref: '#/components/schemas/SurveyValidation' unevaluatedProperties: false SurveyCsatElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - scale - range properties: type: type: string enum: - csat scale: type: string enum: - number - smiley - star range: type: integer enum: - 5 lowerLabel: $ref: '#/components/schemas/TranslatableText' upperLabel: $ref: '#/components/schemas/TranslatableText' isColorCodingEnabled: type: boolean default: false unevaluatedProperties: false SurveyCesElement: allOf: - $ref: '#/components/schemas/SurveyElementBase' - type: object required: - scale - range properties: type: type: string enum: - ces scale: type: string enum: - number - smiley - star range: type: integer enum: - 5 - 7 lowerLabel: $ref: '#/components/schemas/TranslatableText' upperLabel: $ref: '#/components/schemas/TranslatableText' isColorCodingEnabled: type: boolean default: false unevaluatedProperties: false SurveyConditionGroup: type: object required: - id - connector - conditions properties: id: type: string format: cuid2 connector: type: string enum: - and - or conditions: type: array items: oneOf: - $ref: '#/components/schemas/SurveyCondition' - $ref: '#/components/schemas/SurveyConditionGroup' additionalProperties: false SurveyLogicAction: oneOf: - $ref: '#/components/schemas/SurveyCalculateAction' - $ref: '#/components/schemas/SurveyRequireAnswerAction' - $ref: '#/components/schemas/SurveyJumpToBlockAction' description: > Logic action. Keep referenced ids stable: `calculate.variableId` points to a variable id, `requireAnswer.target` points to an element id, and `jumpToBlock.target` points to a block id or ending id. SegmentFilter: description: > A single targeting condition. `root.type` selects the subject and determines the valid `qualifier.operator` set: `attribute` (a workspace contact-attribute key), `person` (a built-in person identifier such as `userId`/`email`), `segment` (membership in another segment), or `device`. Each variant is one member of this union; the matching member is chosen by `root.type`. oneOf: - title: AttributeFilter description: Matches on a workspace contact-attribute value. type: object required: - id - root - qualifier - value properties: id: type: string format: cuid2 root: type: object required: - type - contactAttributeKey properties: type: type: string enum: - attribute contactAttributeKey: type: string description: >- A contact-attribute key defined in the workspace (e.g. `plan`, `role`). additionalProperties: false qualifier: type: object required: - operator properties: operator: type: string enum: - lessThan - lessEqual - greaterThan - greaterEqual - equals - notEquals - isSet - isNotSet - contains - doesNotContain - startsWith - endsWith - isOlderThan - isNewerThan - isBefore - isAfter - isBetween - isSameDay additionalProperties: false value: $ref: '#/components/schemas/SegmentFilterValue' additionalProperties: false - title: PersonFilter description: Matches on a built-in person identifier. type: object required: - id - root - qualifier - value properties: id: type: string format: cuid2 root: type: object required: - type - personIdentifier properties: type: type: string enum: - person personIdentifier: type: string description: A built-in person identifier (e.g. `userId`). additionalProperties: false qualifier: type: object required: - operator properties: operator: type: string enum: - equals - notEquals - isSet - isNotSet - contains - doesNotContain - startsWith - endsWith additionalProperties: false value: $ref: '#/components/schemas/SegmentFilterValue' additionalProperties: false - title: SegmentFilter description: Matches on membership in another segment. type: object required: - id - root - qualifier - value properties: id: type: string format: cuid2 root: type: object required: - type - segmentId properties: type: type: string enum: - segment segmentId: type: string description: Id of the segment to test membership against. additionalProperties: false qualifier: type: object required: - operator properties: operator: type: string enum: - userIsIn - userIsNotIn additionalProperties: false value: $ref: '#/components/schemas/SegmentFilterValue' additionalProperties: false - title: DeviceFilter description: Matches on the contact's device type. type: object required: - id - root - qualifier - value properties: id: type: string format: cuid2 root: type: object required: - type - deviceType properties: type: type: string enum: - device deviceType: type: string description: Device type (e.g. `desktop`, `phone`). additionalProperties: false qualifier: type: object required: - operator properties: operator: type: string enum: - equals - notEquals additionalProperties: false value: $ref: '#/components/schemas/SegmentFilterValue' additionalProperties: false SurveyElementBase: type: object required: - id - type - headline - required properties: id: type: string pattern: ^[a-zA-Z0-9_-]+$ description: Stable element id. Avoid spaces and reserved ids. type: type: string enum: - openText - multipleChoiceSingle - multipleChoiceMulti - nps - rating - csat - ces - consent - pictureSelection - cta - date - fileUpload - cal - matrix - address - ranking - contactInfo headline: $ref: '#/components/schemas/TranslatableText' subheader: $ref: '#/components/schemas/TranslatableText' required: type: boolean imageUrl: type: string imageAltText: allOf: - $ref: '#/components/schemas/TranslatableText' description: >- Text alternative for `imageUrl`, read by screen readers. Omit or leave empty for a decorative image (rendered as `alt=""`). videoUrl: type: string isDraft: type: boolean description: Draft marker used by the editor and future update rules. SurveyCharLimit: type: object description: Optional `openText` character limit configuration. properties: enabled: type: boolean default: false min: type: number max: type: number additionalProperties: false SurveyValidation: type: object description: Optional element-level validation rules. required: - rules properties: logic: type: string enum: - and - or default: and rules: type: array items: $ref: '#/components/schemas/SurveyValidationRule' additionalProperties: false SurveyChoice: type: object required: - id - label properties: id: type: string description: Stable choice id. label: $ref: '#/components/schemas/TranslatableText' additionalProperties: false SurveyShuffleOption: type: string enum: - none - all - exceptLast - reverseOrderOccasionally - reverseOrderExceptLast SurveyMultipleChoiceDisplayType: type: string enum: - list - dropdown SurveyPictureChoice: type: object required: - id - imageUrl properties: id: type: string description: Stable picture choice id. imageUrl: type: string imageAltText: allOf: - $ref: '#/components/schemas/TranslatableText' description: >- Text alternative for `imageUrl`, read by screen readers. Omit or leave empty to fall back to the positional label ("Option 1", "Option 2", …); a choice image is never decorative, since the respondent selects it. additionalProperties: false SurveyToggleInputConfig: type: object description: Field config for address and contact info elements. required: - show - required - placeholder properties: show: type: boolean required: type: boolean placeholder: $ref: '#/components/schemas/TranslatableText' additionalProperties: false SurveyCondition: type: object description: > Single condition. Operators such as `isSubmitted`, `isSkipped`, `isClicked`, `isAccepted`, `isBooked`, `isSet`, and `isEmpty` do not use `rightOperand`; comparison operators do. required: - id - leftOperand - operator properties: id: type: string format: cuid2 leftOperand: $ref: '#/components/schemas/SurveyDynamicReference' operator: type: string enum: - equals - doesNotEqual - contains - doesNotContain - startsWith - doesNotStartWith - endsWith - doesNotEndWith - isSubmitted - isSkipped - isGreaterThan - isLessThan - isGreaterThanOrEqual - isLessThanOrEqual - equalsOneOf - includesAllOf - includesOneOf - doesNotIncludeOneOf - doesNotIncludeAllOf - isClicked - isNotClicked - isAccepted - isBefore - isAfter - isBooked - isPartiallySubmitted - isCompletelySubmitted - isSet - isNotSet - isEmpty - isNotEmpty - isAnyOf rightOperand: $ref: '#/components/schemas/SurveyLogicOperand' additionalProperties: false SurveyCalculateAction: type: object description: Updates a survey variable when the logic rule matches. required: - id - objective - variableId - operator - value properties: id: type: string format: cuid2 objective: type: string enum: - calculate variableId: type: string format: cuid2 description: Variable id for `calculate`. operator: type: string enum: - assign - concat - add - subtract - multiply - divide value: $ref: '#/components/schemas/SurveyLogicOperand' additionalProperties: false SurveyRequireAnswerAction: type: object description: Requires an element/question to be answered before continuing. required: - id - objective - target properties: id: type: string format: cuid2 objective: type: string enum: - requireAnswer target: type: string description: Target element id. additionalProperties: false SurveyJumpToBlockAction: type: object description: Jumps to another block or ending when the logic rule matches. required: - id - objective - target properties: id: type: string format: cuid2 objective: type: string enum: - jumpToBlock target: type: string format: cuid2 description: Target block id or ending id. additionalProperties: false SegmentFilterValue: description: > Comparison value for a segment filter condition. A string or number for most operators; a relative-date object (`{ amount, unit }`) for `isOlderThan` / `isNewerThan`; a two-element `[from, to]` string array for `isBetween`. Ignored for `isSet` / `isNotSet` but still required. oneOf: - type: string - type: number - type: object required: - amount - unit properties: amount: type: number unit: type: string enum: - days - weeks - months - years additionalProperties: false - type: array items: type: string minItems: 2 maxItems: 2 SurveyValidationRule: type: object required: - id - type - params properties: id: type: string type: type: string enum: - minLength - maxLength - pattern - email - url - phone - equals - doesNotEqual - contains - doesNotContain - minValue - maxValue - isGreaterThan - isLessThan - minSelections - maxSelections - minRanked - rankAll - minRowsAnswered - answerAllRows - isLaterThan - isEarlierThan - isBetween - isNotBetween - fileExtensionIs - fileExtensionIsNot params: type: object additionalProperties: true field: type: string enum: - addressLine1 - addressLine2 - city - state - zip - country - firstName - lastName - email - phone - company additionalProperties: false SurveyDynamicReference: type: object description: Dynamic reference to another value in the survey document. required: - type - value properties: type: type: string enum: - element - variable - hiddenField - reserved value: type: string description: >- Element id, variable id, hidden field id, or — for `reserved` — the name of an Embedded Data field-catalog entry (`country`, `deviceType`, `utmSource`, …). Reserved names are checked for non-emptiness only, deliberately not against the catalog, so a survey authored against a newer catalog still parses on an older self-hosted deployment. meta: type: object additionalProperties: type: string additionalProperties: false SurveyLogicOperand: oneOf: - type: object required: - type - value properties: type: type: string enum: - static value: oneOf: - type: string - type: number - type: array items: type: string additionalProperties: false - $ref: '#/components/schemas/SurveyDynamicReference' responses: V3Unauthorized: description: Not authenticated (no valid session or API key). headers: WWW-Authenticate: schema: type: string example: Bearer realm="formbricks" description: >- Authentication scheme challenge. RFC 9110 §15.5.2 asks a 401 for a challenge "applicable to the target resource", and Bearer is applicable here because these operations accept the API key as `Authorization: Bearer ` as well as `x-api-key`. Session-cookie-only operations send no challenge — see `V3UnauthorizedSession`. The MCP endpoints send a richer OAuth challenge carrying `resource_metadata` and `scope`. X-Request-Id: schema: type: string description: Request correlation ID Cache-Control: schema: type: string example: private, no-store content: application/problem+json: schema: $ref: '#/components/schemas/Problem' V3TooManyRequests: description: Rate limit exceeded. headers: X-Request-Id: schema: type: string description: Request correlation ID Cache-Control: schema: type: string example: private, no-store Retry-After: schema: type: integer description: Seconds until the current rate-limit window resets. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' V3InternalServerError: description: Internal Server Error. headers: X-Request-Id: schema: type: string description: Request correlation ID Cache-Control: schema: type: string example: private, no-store content: application/problem+json: schema: $ref: '#/components/schemas/Problem' securitySchemes: sessionAuth: type: apiKey in: cookie name: next-auth.session-token description: > NextAuth session JWT cookie. **Development:** often `next-auth.session-token`. **Production (HTTPS):** often `__Secure-next-auth.session-token`. Send the cookie your browser receives after sign-in. apiKeyAuth: type: apiKey in: header name: x-api-key description: > Management API key; must include **workspaceId** as an allowed workspace with read, write, or manage permission. bearerAuth: type: http scheme: bearer description: > The same management API key, presented as `Authorization: Bearer ` instead of `x-api-key`. Equivalent in every way — same key, same workspace permissions — and offered because it is what most HTTP clients and SDK generators reach for by default. A **401** from any operation that accepts it carries `WWW-Authenticate: Bearer realm="formbricks"`. Session-only operations accept neither this nor `x-api-key`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.