Actualizar documento en PandaDoc, con una API
Actualiza un documento en estado document.draft: name, destinatarios, variables, campos, bloques de texto, tablas de precios, metadata y tags. Para un documento ya enviado, llama antes a Move document to draft.
- Identificador
- pandadoc_update_document
La llamada
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>"
}
}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ámetro | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string | Sí | Id of the document, from List documents or Create document. |
| name | string | No | New name of the document. |
| recipients | array | No | Recipients to change or add. With id, the existing recipient is updated; without id, a new recipient is added as a copy (CC). |
| tokens | array | No | Values of the document variables, as listed by Get document. |
| fields | object | No | Values 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. |
| texts | array | No | New content for text blocks, by block name, as listed by Get document. |
| pricing_tables | array | No | New 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. |
| metadata | object | No | Key-value data to store with the document. Existing keys are updated and new keys are added. |
| tags | array | No | Tags of the document. |
Conexiones posibles
Tu cliente conecta su cuenta de PandaDoc 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/pandadoc, 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/pandadoc_update_document. Se convierte en la definición de tool de tu agente sin conversión.
Otras tools de PandaDoc
- Listar documentosGETLista los documentos del workspace con id, name, status y fechas, 50 por página por defecto. Pide la página siguiente con page; una página con menos resultados que count es la última.
- Obtener documentoGETDevuelve los detalles de un documento: status, destinatarios con su id, has_completed y shared_link, campos, tokens, precios, textos, metadata y tags. Funciona una vez que el documento sale del estado document.uploaded.
- Obtener estado del documentoGETDevuelve el id, el name y el status de un documento. Después de Create document, el estado se queda en document.uploaded unos segundos; espera document.draft antes de actualizarlo o enviarlo.
- Crear documentoPOSTCrea un documento a partir de una plantilla (template_uuid) o de un PDF público (url y name). Queda en document.uploaded unos segundos y luego pasa a document.draft. No se envía nada: llama a Send document cuando Get document status muestre document.draft.
- Mover documento a borradorPOSTMueve un documento enviado o completado de vuelta a document.draft para que Update document pueda modificarlo. Se borran los campos de firma e iniciales, los destinatarios no reciben aviso y el documento debe enviarse de nuevo.
- Enviar documentoPOSTEnvía un documento en estado document.draft a sus destinatarios, por email salvo que silent sea true, y lo pasa a document.sent, lo que bloquea su estructura. Con una clave de sandbox, los destinatarios deben compartir el dominio de email del remitente.
- Enviar recordatorio del documentoPOSTEnvía ahora un recordatorio a los destinatarios que aún deben completar un documento enviado. El resultado indica, por destinatario, si cada recordatorio salió; con orden de firma, solo se puede recordar al firmante actual.
- Eliminar documentoDELETEElimina un documento. Con forever false va a la Papelera, de donde se puede restaurar; sin forever, PandaDoc lo elimina de forma permanente.
Toolkits de la misma categoría
Ver los 100 toolkitsMira Connect aplicado a tu producto.
Pruébalo durante 15 días sin tarjeta, o cuéntale tu caso a nuestro equipo.
