Atualizar documento no PandaDoc, por uma API

Atualiza um documento no status document.draft: name, destinatários, variáveis, campos, blocos de texto, tabelas de preços, metadata e tags. Para um documento já enviado, chame Move document to draft antes.

Identificador
pandadoc_update_document

A chamada

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

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "id": "<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
idstringSimId of the document, from List documents or Create document.
namestringNãoNew name of the document.
recipientsarrayNãoRecipients to change or add. With id, the existing recipient is updated; without id, a new recipient is added as a copy (CC).
tokensarrayNãoValues of the document variables, as listed by Get document.
fieldsobjectNãoValues of the fields by field name, as listed by Get document. Each value is an object with value (text, number, boolean or an RFC 3339 date) and, optionally, the role it belongs to, like {"Company": {"value": "Acme"}}. Signature fields cannot be filled.
textsarrayNãoNew content for text blocks, by block name, as listed by Get document.
pricing_tablesarrayNãoNew content for pricing tables, by table name, as listed by Get document. Send every product of a table, because the table is rebuilt from what you send.
metadataobjectNãoKey-value data to store with the document. Existing keys are updated and new keys are added.
tagsarrayNãoTags of the document.

Conexões possíveis

O seu cliente conecta a conta do PandaDoc 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.

OAuth com o app do seu produto

Você cadastra o app OAuth do seu produto uma vez, em POST /api/merchants/credentials/pandadoc, e o cliente autoriza a conta numa tela de consentimento. O Connect renova o token quando ele está para vencer.

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/pandadoc_update_document. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do PandaDoc

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.