PandaDoc
documents_update
Update a document. Document must be in Draft status. You can update text blocks, fields, and other document properties. After creating a new document, wait for it to reach Draft status before updating. To modify individual recipients, use `recipients_*` tools — the `recipients` param here replaces the entire list.
Remote svitlana-omelia/pandadoc
Remote (network-hosted)
Other tools also called documents_update?
See providers with this name
Input Schema
{
"type": "object",
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Document URL"
},
"name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null,
"description": "Document name"
},
"tags": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"default": null,
"description": "Document tags"
},
"texts": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"data"
],
"properties": {
"data": {
"type": "string"
},
"name": {
"type": "string"
}
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "List of text blocks to update. Each item should have 'name' and 'data' fields"
},
"fields": {
"anyOf": [
{
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"value"
],
"properties": {
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"value": {
"anyOf": [
{
"type": "string"
},
{
"type": "integer"
},
{
"type": "boolean"
}
]
}
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Document fields as key-value pairs"
},
"images": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"urls"
],
"properties": {
"name": {
"type": "string"
},
"urls": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Images"
},
"tables": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"data"
],
"properties": {
"data": {
"type": "object",
"required": [
"sections"
],
"properties": {
"sections": {
"type": "array",
"items": {
"type": "object",
"properties": {
"rows": {
"type": "array",
"items": {
"type": "array",
"items": {
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string"
},
"col_span": {
"type": "integer",
"default": 1,
"minimum": 0
},
"row_span": {
"type": "integer",
"default": 1,
"minimum": 0
}
}
}
}
},
"header": {
"type": "array",
"items": {
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string"
},
"col_span": {
"type": "integer",
"default": 1,
"minimum": 0
},
"row_span": {
"type": "integer",
"default": 1,
"minimum": 0
}
}
}
}
}
},
"minItems": 1
}
}
},
"name": {
"type": "string"
}
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Tables to populate by name"
},
"tokens": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"value"
],
"properties": {
"name": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Document tokens (variables). Each should have name and value."
},
"metadata": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null,
"description": "Document metadata as key-value pairs"
},
"recipients": {
"anyOf": [
{
"type": "array",
"items": {
"anyOf": [
{
"type": "object",
"properties": {
"id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"redirect": {
"anyOf": [
{
"type": "object",
"properties": {
"url": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"is_enabled": {
"type": "boolean",
"default": false
}
}
},
{
"type": "null"
}
],
"default": null
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"signing_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
},
"delivery_methods": {
"anyOf": [
{
"type": "object",
"properties": {
"sms": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"email": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "null"
}
],
"default": null
},
"verification_settings": {
"anyOf": [
{
"type": "object",
"properties": {},
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null
}
}
},
{
"type": "object",
"required": [
"name",
"members"
],
"properties": {
"name": {
"type": "string"
},
"role": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"type": {
"type": "string",
"const": "recipient_group",
"default": "recipient_group"
},
"members": {
"type": "array",
"items": {
"type": "object",
"properties": {
"email": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"phone": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"last_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
},
"first_name": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"signing_order": {
"anyOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"default": null
}
}
}
]
}
},
{
"type": "null"
}
],
"default": null,
"description": "List of recipients. Each should have email, first_name, last_name, etc."
},
"document_id": {
"type": "string",
"description": "Document ID"
},
"pricing_tables": {
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"sections"
],
"properties": {
"name": {
"type": "string"
},
"options": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null,
"description": "Table-level settings: currency, discount, tax_first, tax_second. Discount: {name, type: 'absolute'|'percent', value}. Tax: {name, type: 'percent', value}."
},
"sections": {
"type": "array",
"items": {
"type": "object",
"required": [
"title"
],
"properties": {
"rows": {
"type": "array",
"items": {
"type": "object",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"description": "Row data keyed by column name (e.g. name, price, qty, description). Tax/discount columns use {value, type: 'percent'}.",
"additionalProperties": true
},
"options": {
"type": "object",
"properties": {
"optional": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"qty_editable": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"optional_selected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
},
"multichoice_selected": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
}
},
"custom_fields": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"default": null
}
}
}
},
"title": {
"type": "string"
},
"default": {
"type": "boolean",
"default": true
},
"multichoice_enabled": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
}
},
"minItems": 1
},
"data_merge": {
"anyOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"default": null
}
}
}
},
{
"type": "null"
}
],
"default": null,
"description": "Pricing tables to populate by name"
}
}
}