Atualizar formulário no Tally, por uma API

Altera o nome, o status, as configurações ou os blocos de um formulário. Enviar blocks substitui todos eles, então leia o formulário com Obter formulário antes; name, status e settings podem ir sozinhos.

Identificador
tally_update_form

A chamada

POST https://connect.reportei.com/api/tools/tally_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>"
  }
}

Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.

Parâmetros

As descrições dos parâmetros seguem a documentação oficial do app, em inglês.

ParâmetroTipoObrigatórioDescrição
form_idstringSimId of the form, from List forms or from the form URL: wA0Bc1 in https://tally.so/r/wA0Bc1.
namestringNãoNew name of the form.
statusstringNãoPUBLISHED puts the form live, DRAFT keeps the changes unpublished. Deleting is not done here.Valores: BLANK, DRAFT, PUBLISHED
blocksarrayNãoEvery block of the form, in order: this list replaces the current blocks, so send all of them, the existing ones with the uuid and groupUuid from Get form, and a block left out is removed. A question is a TITLE block with groupType QUESTION and the question in payload.html, followed by its input block, like INPUT_TEXT, INPUT_EMAIL or TEXTAREA, whose groupType repeats the type. The form title is a FORM_TITLE block with groupType TEXT and the title in payload.html.
settingsobjectNãoForm settings. Other Tally settings, like the respondent email and the data retention, also go here.

Conexões possíveis

O seu cliente conecta a conta do Tally uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.

Chave de API

O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.

A resposta

Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.

Pronta para agentes de IA

O input desta tool é um JSON Schema, disponível em GET /api/tools/tally_update_form. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Tally

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.