create_form

Parameters schema

{
  "type": "object",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "required": [
    "organizationId",
    "userId",
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 255,
      "minLength": 1,
      "description": "The name of the form"
    },
    "tone": {
      "type": "string",
      "description": "Optional tone for the form (e.g., 'friendly', 'professional')"
    },
    "type": {
      "enum": [
        "dynamic",
        "structured"
      ],
      "type": "string",
      "description": "Funnel type: 'structured' creates a Logic Funnel (default), 'dynamic' creates an AI Funnel"
    },
    "theme": {
      "type": "object",
      "required": [
        "colorBackground",
        "colorForeground",
        "colorPrimary",
        "colorButtonText",
        "fontFamily",
        "textSize",
        "textAnimation",
        "buttonRadius",
        "buttonSize"
      ],
      "properties": {
        "textSize": {
          "enum": [
            "regular",
            "medium"
          ],
          "type": "string",
          "description": "Text size for form content"
        },
        "buttonSize": {
          "enum": [
            "regular",
            "medium",
            "large"
          ],
          "type": "string",
          "description": "Button size preset"
        },
        "fontFamily": {
          "enum": [
            "sans",
            "serif",
            "mono",
            "inter",
            "merriweather",
            "cabin",
            "fira-sans",
            "nunito",
            "roboto",
            "lato",
            "raleway",
            "crimson-pro",
            "poppins",
            "montserrat"
          ],
          "type": "string",
          "description": "Font family for the form"
        },
        "buttonRadius": {
          "type": "number",
          "description": "Button border radius in pixels"
        },
        "colorPrimary": {
          "type": "string",
          "description": "Primary accent color hex value"
        },
        "textAnimation": {
          "enum": [
            "typing",
            "blur-reveal"
          ],
          "type": "string",
          "description": "Text entrance animation style"
        },
        "colorBackground": {
          "type": "string",
          "description": "Background color hex value (e.g. #ffffff)"
        },
        "colorButtonText": {
          "type": "string",
          "description": "Button text color hex value"
        },
        "colorForeground": {
          "type": "string",
          "description": "Foreground/text color hex value"
        }
      },
      "description": "Visual theme configuration"
    },
    "userId": {
      "type": "string",
      "description": "The user ID creating the form"
    },
    "endings": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "title",
          "description",
          "message"
        ],
        "properties": {
          "id": {
            "type": "string"
          },
          "title": {
            "type": "string",
            "maxLength": 100,
            "minLength": 1
          },
          "message": {
            "type": "string",
            "maxLength": 1000,
            "minLength": 1
          },
          "imageUrl": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "null"
              }
            ]
          },
          "background": {
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "description": {
            "type": "string",
            "maxLength": 500
          },
          "callToActionUrl": {
            "anyOf": [
              {
                "type": "string",
                "format": "uri"
              },
              {
                "type": "null"
              }
            ]
          },
          "callToActionText": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 50
              },
              {
                "type": "null"
              }
            ]
          }
        }
      },
      "description": "Multiple quiz endings for conditional selection"
    },
    "branding": {
      "type": "object",
      "required": [
        "hideWatermark",
        "logoUrl",
        "logoLinkUrl"
      ],
      "properties": {
        "logoUrl": {
          "type": "string",
          "description": "URL of the custom logo image"
        },
        "logoLinkUrl": {
          "type": "string",
          "description": "URL the logo links to when clicked"
        },
        "hideWatermark": {
          "type": "boolean",
          "description": "Whether to hide the Dashform watermark (Pro/Business)"
        }
      },
      "description": "Branding settings (logo, watermark)"
    },
    "snippets": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Information snippets for AI to reference"
    },
    "endScreen": {
      "type": "object",
      "required": [
        "message",
        "callToActionText",
        "callToActionUrl"
      ],
      "properties": {
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "background": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ]
        },
        "callToActionUrl": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "callToActionText": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "description": "End screen configuration"
    },
    "questions": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "key",
          "required",
          "type",
          "description"
        ],
        "properties": {
          "key": {
            "type": "string"
          },
          "type": {
            "enum": [
              "open-ended",
              "single-choice",
              "multiple-choice",
              "rating",
              "email",
              "phone",
              "date",
              "scale"
            ],
            "type": "string"
          },
          "options": {
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "branches": {
            "type": "array",
            "items": {
              "type": "object",
              "required": [
                "targetQuestionKey",
                "groups"
              ],
              "properties": {
                "groups": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "type": "object",
                      "required": [
                        "questionKey",
                        "operator"
                      ],
                      "properties": {
                        "value": {
                          "type": "string"
                        },
                        "negate": {
                          "type": "boolean",
                          "default": false
                        },
                        "operator": {
                          "enum": [
                            "equals",
                            "contains",
                            "startsWith",
                            "endsWith",
                            "regex",
                            "exists"
                          ],
                          "type": "string"
                        },
                        "questionKey": {
                          "type": "string",
                          "minLength": 1
                        }
                      }
                    },
                    "minItems": 1
                  },
                  "minItems": 1
                },
                "targetQuestionKey": {
                  "type": "string",
                  "minLength": 1
                }
              }
            }
          },
          "required": {
            "type": "boolean"
          },
          "background": {
            "anyOf": [
              {},
              {
                "type": "null"
              }
            ]
          },
          "description": {
            "type": "string"
          }
        }
      },
      "description": "List of questions for Logic Funnels"
    },
    "backgrounds": {
      "type": "array",
      "items": {},
      "maxItems": 10,
      "description": "Array of backgrounds that cycle through questions"
    },
    "description": {
      "type": "string",
      "description": "Optional description of the form"
    },
    "welcomeScreen": {
      "type": "object",
      "required": [
        "title",
        "message",
        "callToActionText"
      ],
      "properties": {
        "title": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "message": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "background": {
          "anyOf": [
            {},
            {
              "type": "null"
            }
          ]
        },
        "redirectUrl": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        },
        "callToActionText": {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ]
        }
      },
      "description": "Welcome screen configuration"
    },
    "organizationId": {
      "type": "string",
      "description": "The organization ID to create the form in"
    },
    "endScreenEnabled": {
      "type": "boolean",
      "description": "Whether to enable the end screen"
    },
    "maxFollowUpQuestions": {
      "type": "number",
      "maximum": 10,
      "minimum": 0,
      "description": "Maximum number of follow-up questions for AI Funnels"
    }
  }
}

No endpoints wrapped at confidence ≥ 0.50.

Parent server