Create form with the Typeform API

Creates a form in a workspace and returns it with its id, field ids and the public link in _links.display. Images in fields and screens must already exist in the account.

Identifier
typeform_create_form

The request

POST https://connect.reportei.com/api/tools/typeform_create_form/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "title": "<title>",
    "workspace": {}
  }
}

Your system sends your customer's connection id and the tool arguments. The headers are the same as the rest of the Connect API: your product's token and your customer's token.

Parameters

ParameterTypeRequiredDescription
titlestringYesTitle of the form.
workspaceobjectYesWorkspace that holds the form: the self.href of a workspace from List workspaces, like https://api.typeform.com/workspaces/Aw33bz.
typestringNoForm type. Typeform uses quiz when it is left out.Values: quiz, classification, score, branching, classification_branching, score_branching
themeobjectNoTheme of the form: https://api.typeform.com/themes/ followed by an id from List themes. Leaving it out applies a new copy of the default theme.
settingsobjectNoForm settings. Other keys of the Typeform settings object, like duplicate_prevention, also go here.
hiddenarrayNoNames of the hidden fields, filled from the form URL, like utm_source or email.
variablesobjectNoStarting values of the score and price variables, for quizzes and order forms.
welcome_screensarrayNoScreens shown before the first question.
thankyou_screensarrayNoScreens shown after the submission.
fieldsarrayNoQuestions of the form, in order. Each type takes its own options and validations.
logicarrayNoLogic jumps and score or price calculations, one entry per field or hidden field that triggers them.

Supported connections

Your customer connects their Typeform account once, with one of the modes below. The same connection serves every tool of the toolkit.

API key

Your customer pastes the app's key on a Connect screen, or your system sends the key with POST /api/customer-toolkits, with no screen.

OAuth with your product's app

You register your product's OAuth app once, with POST /api/merchants/credentials/typeform, and your customer authorizes the account on a consent screen. Connect renews the token when it is about to expire.

The response

On success, Connect preserves the app's response status and body. HTTP errors returned by the app use the {error, api_error} envelope; authentication or validation can fail before execution. The X-Toolkit-Execution-Id header identifies the recorded execution, available at GET /api/tools/executions/{uuid}.

Ready for AI agents

This tool's input is a JSON Schema, available at GET /api/tools/typeform_create_form. It becomes your agent's tool definition with no conversion.

Other Typeform tools

See all 9 tools

Toolkits in the same category

See all 100 toolkits

See Connect applied to your product.

Try it for 15 days with no card, or walk our team through your use case.