Actualizar formulario en Typeform, con una API

Reemplaza la definición completa de un formulario. Léelo con Get form, cambia lo que necesites y envía todo de vuelta: cada campo conserva su id, y un campo omitido se elimina junto con sus respuestas en las respuestas existentes.

Identificador
typeform_update_form

La llamada

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

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

Tu sistema envía el id de la conexión de tu cliente y los argumentos de la tool. Los headers son los mismos de toda la API de Connect: el token de tu producto y el token de tu cliente.

Parámetros

Las descripciones de los parámetros siguen la documentación oficial de la app, en inglés.

ParámetroTipoObligatorioDescripción
form_idstringSíId of the form, from List forms or from the form URL: u6nXL7 in https://mysite.typeform.com/to/u6nXL7.
titlestringSíTitle of the form.
workspaceobjectSíWorkspace 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.Valores: 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, even when the form already had one.
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.
fieldsarrayNoEvery question of the form, in order, each existing one with its id from Get form. A field left out is deleted together with its answers in the existing responses.
logicarrayNoLogic jumps and score or price calculations, one entry per field or hidden field that triggers them.

Conexiones posibles

Tu cliente conecta su cuenta de Typeform una sola vez, con uno de los modos de abajo. La misma conexión sirve para todas las tools del toolkit.

Clave de API

Tu cliente pega la clave de la app en una pantalla de Connect, o tu sistema envía la clave con POST /api/customer-toolkits, sin pantalla.

OAuth con la app de tu producto

Registras la app OAuth de tu producto una sola vez, con POST /api/merchants/credentials/typeform, y tu cliente autoriza la cuenta en una pantalla de consentimiento. Connect renueva el token cuando está por vencer.

La respuesta

Si la llamada tiene éxito, Connect conserva el status y el cuerpo de la respuesta de la app. Los errores HTTP devueltos por la app usan el objeto {error, api_error}; la autenticación o validación pueden fallar antes de la ejecución. El header X-Toolkit-Execution-Id identifica la ejecución registrada, disponible en GET /api/tools/executions/{uuid}.

Lista para agentes de IA

El input de esta tool es un JSON Schema, disponible en GET /api/tools/typeform_update_form. Se convierte en la definición de tool de tu agente sin conversión.

Otras tools de Typeform

Ver las 9 tools

Toolkits de la misma categoría

Ver los 100 toolkits

Mira Connect aplicado a tu producto.

Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.