- Category: documents
- Auth: API_KEY
- Composio-managed OAuth available? N/A
- Tools: 16
- Triggers: 0
- Slug:
PANDADOC - Version: 20261101_00
Tools
Add a document recipient
Add a document recipient
PANDADOC_ADD_DOCUMENT_RECIPIENTAdd a document recipient. Add a CC recipient to a document. > 🚧 Before you start > > To add a CC recipient, please ensure that: > > - You have the ‘Can Manage Recipients’ permission. > - This recipient is already created in your contacts. If not, add them using the Create Contact endpoint. To add a new CC recipient to a document, two parameters must be included in the request body: - kind: Set this parameter to contact to specify an individual contact, or contact_group to specify a contact group. - id: Input the ID of the desired contact (for kind: contact) or contact group (for kind: contact_group). To retrieve the contact’s ID, use the List Contacts endpoint to access a list of all contacts, and then locate the desired contact by seaInput Parameters
Output
Add a workspace member
Add a workspace member
Append a content library item to a document
Append a content library item to a document
Bulk-delete documents
Bulk-delete documents
PANDADOC_BULK_DELETE_DOCUMENTSBulk-delete documents. Delete multiple documents in one request by sending a JSON array. Each element must be an object with an id field (the document ID, same value as elsewhere in the Documents API). The caller must have permission to delete each document. Documents must belong to the authenticated workspace. This batch operation returns 200 OK with a JSON body containing an id array of deleted document IDs. That differs from Delete Document (DELETE /public/v1/documents/{id}), which returns 204 No Content for a single document.Input Parameters
Output
Change document ownership
Change document ownership
PANDADOC_CHANGE_DOCUMENT_OWNERSHIPChange document ownership. This operation allows transferring the ownership of a document to another user by specifying the document ID and membership ID.Input Parameters
true, disables the email and in-app notifications about the ownership transfer that are sent to the new document owner.Output
Change document status
Change document status
PANDADOC_CHANGE_DOCUMENT_STATUSChange document status. PandaDoc has eight document statuses, but you can manually set your document status to only four: ### Document statuses - Completed - document.completed - API code 2 - Expired - document.voided - code 11 - Paid - document.paid - code 10. Important: You can only set it if you have a payment app connected. - Declined - document.declined - code 12 > 🚧 Pass a numeric code for the corresponding document status, for example, 2 for document.completed. Find more details in [[Editor 2.0] Manually change document status](https://support.pandadoc.com/en/articles/9714842-manually-change-document-status) topic. | Current Status | To Completed: | To Expired: | To Paid: | To Declined: | |----------------|---------------|-------------|----------|--------------| | Draft | YES | NO | YES | YES | | Approved | NO | NO | NO | NO | | SeInput Parameters
Output
Change Document Status with Upload
Change Document Status with Upload
PANDADOC_CHANGE_DOCUMENT_STATUS_WITH_UPLOADManually change a document’s status with an optional file attachment. Supports completed (2), paid (10), expired (11), and declined (12). Allowed transitions depend on the current document status; paid requires a connected payment app. Setting notify_recipients sends email to recipients. Returns no content on success, not the updated document.Input Parameters
Output
Change a workspace member role
Change a workspace member role
PANDADOC_CHANGE_WORKSPACE_MEMBER_ROLEChange a workspace member role. Change the role of an existing workspace member. - You must be an organization admin, a workspace admin, or hold a role with permission to edit member roles to call this endpoint. - The role field accepts either a built-in role name (Admin, Manager, Member, Collaborator) or the name of a custom role defined for the workspace. - The role of the workspace owner cannot be changed. - The role of the last member with admin privileges in the workspace cannot be changed. - When a member with a Guest license is promoted to any non-Collaborator role, the user’s license is automatically upgraded to Full (Standard). If the organization has no free seats available, an additional seat is purchased.Input Parameters
Output
Create a content library item
Create a content library item
PANDADOC_CREATE_CONTENT_LIBRARY_ITEMCreate a content library item. This API endpoint allows users to create an empty item in the content library. No actual content or data is required to be provided in the initial creation.Input Parameters
true, the DOCX is converted into editable content, so the resulting content library item can be edited.Output
Create Content Library Item from File Upload
Create Content Library Item from File Upload
PANDADOC_CREATE_CONTENT_LIBRARY_ITEM_FROM_UPLOADUpload a file to create a PandaDoc content library item asynchronously. The maximum upload size is 100 MB. Field tags and form fields are not supported. A successful upload does not mean processing is complete: check the item’s status until cli.PROCESSED or cli.ERROR. DOCX uploads support editable conversion. See POST /public/v1/content-library-items?upload (createContentLibraryItemFromUpload).Input Parameters
Output
Create Document Attachment
Create Document Attachment
PANDADOC_CREATE_DOCUMENT_ATTACHMENTCreates and adds an attachment to a PandaDoc document. This tool allows you to attach downloadable files such as supplemental materials, Excel spreadsheets, or other content without embedding them directly into the document. Attachments can be added only to documents in ‘document.draft’ status, with a maximum of 10 files per document and a size limit of 50MB per file.Input Parameters
Output
Create a document editing session
Create a document editing session
PANDADOC_CREATE_DOCUMENT_EDITING_SESSIONCreate a document editing session. Creates a new editing session for the Embedded Editor. The response includes an E-Token, which is required to open the document. > 🚧 Important: The Embedded Editor can only open documents that have a draft status. #### Limitations - Single Active Session per User-Document Pair Only one editing session can be active at a time for a specific user and document. Creating a new session for the same user-document pair will automatically invalidate the previous one. - Weekly Session Cap A maximum of 250 editing sessions can be created for a single document per week. Any attempt to exceed this limit will result in a 403 Forbidden error.Input Parameters
Output
Create document fields
Create document fields
Create Document from File Upload
Create Document from File Upload
PANDADOC_CREATE_DOCUMENT_FROM_FILECreates a new document in PandaDoc by uploading a file (PDF, DOCX, or RTF). Converts existing documents into PandaDoc documents for processing, signing, and tracking. Either file or url must be provided; omitting both will fail. Large files may time out during upload and conversion.Input Parameters
email field; missing or malformed emails will prevent sending or signing.Output
Create a document section
Create a document section
PANDADOC_CREATE_DOCUMENT_SECTIONCreate a document section. With this endpoint, you can add a new section to an existing PandaDoc document (create a bundle). You can upload a section to the document using a PandaDoc template or a file by URL. > ⏱️ Document Section creation is a non-blocking (asynchronous) operation > > The document creation process may take some time. > > With a successful request, you receive a response with the created upload ID and status document_sections_upload.uploaded. After processing completes on our servers, usually a few seconds, the document moves to the document_sections_upload.PROCESSED status. ## Using a PandaDoc template <details> > 🚧 Current Version Limitations > > Images in sections are currently not supported. > 📘 Pricing tables note > > Each pricing table must have a unique name to populate it with data correctly. A PandaDoc template is a document templateInput Parameters
Output
Create Document Section from File Upload
Create Document Section from File Upload
PANDADOC_CREATE_DOCUMENT_SECTION_FROM_UPLOADAdd a section to an existing version 2 document from a PDF, DOCX, or RTF. Uploads one file of at most 50 MB; encrypted PDFs are unsupported. Creation is asynchronous: poll Document Section Upload Status using the returned upload uuid until PROCESSED (or ERROR) before relying on the section being available. This uploads embedded document content, not a downloadable attachment.Input Parameters
Output
Create an embedded signing session
Create an embedded signing session
PANDADOC_CREATE_EMBEDDED_SIGNING_SESSIONCreate an embedded signing session. Creates a document session for a recipient to view and sign a document. > 📘 How to create an Embedded Sign session > For more information on how to create an Embedded Sign session, see the Embedded Signing documentation.Input Parameters
"lifetime": 31535999). If not specified, the default value is 1 hour (3600 seconds).Output
Create Document Folder
Create Document Folder
Create a linked object
Create a linked object
PANDADOC_CREATE_LINKED_OBJECTCreate a linked object. Create a linked object in the document. > 🚧 > > You can only link each document to each CRM once. This ensures the consistent functionality of the two-way CRM sync. > > You can, however, link one document to several external systems.Input Parameters
Output
Create a notarization request
Create a notarization request
PANDADOC_CREATE_NOTARIZATION_REQUESTCreate a notarization request. Create a notarization request to connect with a notary and complete online notarizations for your signers within minutes. > 🚧 Important: This endpoint supports only documents in draft status. ## Prerequisites > 🚧 Before you start > > Ensure the following before creating a notarization request: > > - Install the Notary On-Demand or Notary add-on > - Create a document for notarization and get its document_id. To create a document, use the Create Document from Template or Create Document from File Upload endpoint. ## Request Details For the notarization request, include in the request body: - document_id - At least one invitees, specifying their email, first_name, and `last_naInput Parameters
Output
Create or Update Contact
Create or Update Contact
Create a product catalog item
Create a product catalog item
Create Template
Create Template
PANDADOC_CREATE_TEMPLATEThis tool allows users to create a new template in PandaDoc from a PDF file or from scratch. It handles file upload validation, parameter checks, proper error handling, and authentication with the PandaDoc API. The template can be created either by uploading a PDF file or by providing a structured content object that defines the template layout and elements.Input Parameters
Output
Create a template editing session
Create a template editing session
PANDADOC_CREATE_TEMPLATE_EDITING_SESSIONCreate a template editing session. Creates a new editing session for the Embedded Editor. The response includes an E-Token, which is required to open the template. #### Limitations - Single Active Session per User-Template Pair Only one editing session can be active at a time for a specific user and template. Creating a new session for the same user-template pair will automatically invalidate the previous one. - Weekly Session Cap A maximum of 250 editing sessions can be created for a single template per week. Any attempt to exceed this limit will result in a 403 Forbidden error.Input Parameters
Output
Create a template folder
Create a template folder
PANDADOC_CREATE_TEMPLATE_FOLDERCreate a template folder. Create a new folder to store your templates. For the full list of folder operations and their limitations, see Organize Templates and Folders.Input Parameters
Output
Create a user
Create a user
PANDADOC_CREATE_USERCreate a user. Create users, and assign them roles, licenses, and workspaces. - You must be an organization admin to create users. - We check that the user email domain matches your organization domain. - We check that the user email and phone number have a valid format.Input Parameters
Output
Create PandaDoc Webhook
Create PandaDoc Webhook
PANDADOC_CREATE_WEBHOOKCreates a new webhook subscription in PandaDoc to receive notifications about specific events. This action allows you to set up webhook notifications for various document-related events such as status changes, recipient completions, and updates. The webhook will send HTTP notifications to your specified endpoint when the configured events occur.Input Parameters
Output
Create a workspace
Create a workspace
PANDADOC_CREATE_WORKSPACECreate a workspace. Create a workspace in your organization. - You need to be an Org Admin to create a workspace. - You will be added to the new workspace with an Admin role.Input Parameters
Output
Deactivate a workspace
Deactivate a workspace
Delete Contact
Delete Contact
Delete a document
Delete a document
Delete a document attachment
Delete a document attachment
Delete a document recipient
Delete a document recipient
PANDADOC_DELETE_DOCUMENT_RECIPIENTDelete a document recipient. Remove a recipient from a document. > 🚧 Before you start > > Please ensure that you have the ‘Can Manage Recipients’ permission. To remove a recipient from a document, you must specify their ID in the path parameter (note that this is different from their contact’s ID). The recipient’s ID can be retrieved via the Document Details endpoint. ### Document status - Removing a signer is only possible when the document is in the ‘Draft’ (document.draft) status and this action will unassign all fields associated with that signer. - Removing a CC recipient is allowed in any document status except for the ‘Expired’ (document.voided) and ‘Declined’ (document.declined). If a CC recipient is removed, their access will be revoked.Input Parameters
Output
Delete a document section
Delete a document section
Delete a linked object
Delete a linked object
Delete a notarization request
Delete a notarization request
PANDADOC_DELETE_NOTARIZATION_REQUESTDelete a notarization request. Use this method to delete a notarization request. Once notarization request is deleted it cannot be restored. > 🚧 Notarization Request status > > You can only delete a notarization request in status ‘SENT’, ‘WAITING_FOR_NOTARY’ or ‘INCOMPLETE’. > If the notarization request is in any other status, the request will return a 400 Bad Request error. By default all invitees will receive email notification about deletion of the notarization request. If you want to disable this notification, you can use the disable_invitees_notifications parameter when creating request (see Create Notarization Request).Input Parameters
Output
Delete a product catalog item
Delete a product catalog item
Delete Template
Delete Template
Delete a webhook subscription
Delete a webhook subscription
Download a completed document
Download a completed document
PANDADOC_DOWNLOAD_COMPLETED_DOCUMENTDownload a completed document. Download a completed document as a verifiable PDF (Download Protected Document) > 🚧 Production key only > > This endpoint only works with a Production key. You’ll get a 401 Unauthorized error when trying to use a Sandbox key. Download a signed PDF of a completed documentInput Parameters
Output
Download Document
Download Document
PANDADOC_DOWNLOAD_DOCUMENTDownload a PandaDoc document as PDF, or a bundle as separate PDFs in a ZIP. For completed and signed documents, use PandaDoc’s Download Protected Document endpoint instead. If the file is still being generated, retry after the delay reported in the error. Redirects are not followed to protect credentials.Input Parameters
Output
Download a document attachment
Download a document attachment
Duplicate a template
Duplicate a template
PANDADOC_DUPLICATE_TEMPLATEDuplicate a template. ## Duplicate Template Creates a copy of a template within the same workspace. > 📘 Permissions > > Requires can_read_templates and can_duplicate_templates permissions. Duplicating templates owned by other users additionally requires can_duplicate_any_template.Input Parameters
Output
Get API log details
Get API log details
Get attachment details
Get attachment details
Get automatic reminder settings
Get automatic reminder settings
Get automatic reminder status
Get automatic reminder status
PANDADOC_GET_AUTOMATIC_REMINDER_STATUSGet automatic reminder status. Retrieves the current auto reminder status per recipient for a specified document. Recipients who could not receive reminders due to validations (recipient groups, non-signers, etc.) will be skipped and not included in the response.Input Parameters
Output
Get contact details
Get contact details
Get content library item details
Get content library item details
PANDADOC_GET_CONTENT_LIBRARY_ITEM_DETAILSGet content library item details. Retrieve detailed information about a specific content library item using its ID. The details include: - Roles - All fields with values - All tokens with values - Pricing information (pricing tables, products, etc) - Metadata - Tags - Modification Timestamps: note that date_modified means any changes associated with the CLI, while content_date_modified logs any changes in CLI content.Input Parameters
Output
Get content library item status
Get content library item status
PANDADOC_GET_CONTENT_LIBRARY_ITEM_STATUSGet content library item status. Requesting the CLI status helps verify that a CLI is in the expected state before invoking additional API methods. ## Available CLI Statuses The following is a complete list of all possible CLI statuses returned: | CLI Status | Status Description | |-----------------|--------------------| | cli.UPLOADED | The CLI upload process has been initiated and is currently in progress. It will soon transition to the cli.PROCESSED state. | | cli.PROCESSED | The CLI has been successfully uploaded and created. At this stage, all aspects of the CLI are editable. | | cli.ERROR | The CLI upload process has failed. Please refer to the error details in the response for more information. |Input Parameters
Output
Get the current member
Get the current member
PANDADOC_GET_CURRENT_MEMBERGet the current member. Returns the member details of the current user (the owner of the API key). User - is an account with a license in the Organization. Member - is a User with a predefined Role in the Workspace. | Parameter | Description | |---|---| | user_id | A unique identifier of the user in the organization | | membership_id | A unique identifier of the user in the workspace | | email | A user email address | | first_name | A user’s first name | | last_name | A user’s last name | | is_active | A boolean value that identifies if a member is active and not blocked | | workspace | A unique identifier of the user’s current active workspace | | workspace_name | A name of the user’s current active workspace | | email_verified | A boolean value that identifies if the email is verified | | role | A member’s role in the woOutput
Get Document Details
Get Document Details
PANDADOC_GET_DOCUMENT_DETAILSFetch detailed metadata for a specific PandaDoc document including recipients, fields/tokens values, pricing data, metadata, tags, and content-block names. Use this after discovering a document via list/search to inspect recipients/status/fields/metadata/content-block references for follow-up automation or reporting.Input Parameters
Output
Get the document eSign disclosure
Get the document eSign disclosure
Get document section details
Get document section details
Get document settings
Get document settings
Get document status
Get document status
PANDADOC_GET_DOCUMENT_STATUSGet document status. It is useful to request document status to ensure a document is in the expected state before calling additional API methods. ### Required Document Statuses Here are some common methods and the document.status required to proceed: | API Method | Required Document State | | :------------------- | :---------------------- | | Send A Document | document.draft | | Get Document Details | document.draft | | Embed A Document | document.sent | | Download A Document | document.completed | > 📘 Polling vs Webhooks > > If you are using the GET document status endpoint for polling, we also support and recommend using webhooks for event-driven needs: <https://developers.pandadoc.com/docs/listen-document-status-changes#/> ### Available Document Statuses The following is a compInput Parameters
Output
Get member details
Get member details
PANDADOC_GET_MEMBER_DETAILSGet member details. A method to retrieve a member’s details by ID. User - is an account with a license in the Organization. Member - is a User with a predefined Role in the Workspace. | Parameter | Description | |---|---| | user_id | A unique identifier of the user in the organization | | membership_id | A unique identifier of the user in the workspace | | email | A user email address | | first_name | A user’s first name | | last_name | A user’s last name | | is_active | A boolean value that identifies if a member is active and not blocked | | workspace | A unique identifier of the user’s current active workspace | | workspace_name | A name of the user’s current active workspace | | email_verified | A boolean value that identifies if the email is verified | | role | A member’s role in the workspace | | user_license |Input Parameters
Output
Get notarization request details
Get notarization request details
PANDADOC_GET_NOTARIZATION_REQUEST_DETAILSGet notarization request details. Get details about a notarization request by its id. Details include: - Basic notarization request information (status, creator, invitees). - Signed documents information with links for downloading. - Notarization session recording information with link for downloading. - Timestamps associated with a notarization request. - Termination reason and details when the notarization session was not completed successfully. ## Available Notarization Request Statuses The following is a complete list of all possible notarization request statuses returned: | Notarization Request Status | Status Description | | :-------------------------- | :----------------------------------------------------------------------------------------------------------------- | | SENT | Notarization request has been created. Invitees are notified and can start the processInput Parameters
Output
Get a product catalog item
Get a product catalog item
Get section upload status
Get section upload status
PANDADOC_GET_SECTION_UPLOAD_STATUSGet section upload status. Receive the upload status of the document and sections by their upload_id. Requesting document section upload status is useful to ensure a document section upload is in the expected state before calling additional API methods. In response, you receive an array with sections_uuid. You can receive information about each section using the Document Section Info endpoint. json "section_uuids": [ "H8T8CJofGY6JwTsWsPuDEF", "8MwLaU4SaZywqLiDk26mDF" ] ## Available Document Section Upload Statuses The following is a complete list of all possible document statuses returned: | Document Status | Status Description | | :----------------------------------- | :-----------------------------------------------------------------------------------------------------------------------Input Parameters
Output
Get Template Details
Get Template Details
Get template settings
Get template settings
Get template sharing settings
Get template sharing settings
Get template status
Get template status
PANDADOC_GET_TEMPLATE_STATUSGet template status. ## Available Template Statuses The following is a complete list of all possible template statuses returned: | Template Status | Status Description | | :------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- | | template.UPLOADED | The template upload process has been initiated and is currently in progress. It will soon transition to the template.PROCESSED state. | | template.PROCESSED | The template has been successfully uploaded and created. At this stage, all aspects of the template are editable. | | template.ERROR | The template upload process has failed. Please refer to the error details in the response for more information. |Input Parameters
Output
Get a user by ID
Get a user by ID
Get webhook event details
Get webhook event details
Get webhook subscription details
Get webhook subscription details
List API logs
List API logs
PANDADOC_LIST_API_LOGSList API logs. Get the list of all logs within the selected workspace. Optionally filter by date, page, and # of items per page.Input Parameters
count × page) must not exceed 10,000.count × page) must not exceed 10,000.Output
List Contacts
List Contacts
List content library items
List content library items
PANDADOC_LIST_CONTENT_LIBRARY_ITEMSList content library items. The endpoint retrieves items from the content library in PandaDoc. This endpoint supports filtering options to narrow down the results, allowing users to search by query, tags, folder, and more. > ### ⚠️ Please avoid empty values for the parameters > API returns “400” error when any of the parameters has an empty value. Please remove such a parameter from the request or add a value.Input Parameters
Output
List document attachments
List document attachments
List document audit trail
List document audit trail
PANDADOC_LIST_DOCUMENT_AUDIT_TRAILList document audit trail. Retrieves the full audit trail for a specified document. The audit trail includes detailed user actions such as sending, viewing, signing, and editing, along with metadata like timestamps, IP addresses, and user identity. This endpoint is accessible to authorized workspace administrators only.Input Parameters
Output
List document fields
List document fields
List Document Folders
List Document Folders
List Documents
List Documents
PANDADOC_LIST_DOCUMENTSList and search PandaDoc documents with filters, pagination, and ordering.Input Parameters
Output
List documents by linked object
List documents by linked object
PANDADOC_LIST_DOCUMENTS_BY_LINKED_OBJECTList documents by linked object. Get a list of documents connected to a linked object - an entity from an integration.Input Parameters
Output
List document sections
List document sections
List forms
List forms
List linked objects
List linked objects
List notaries
List notaries
PANDADOC_LIST_NOTARIESList notaries. Retrieve a list of notaries associated with your organization. ## Important Notes - At the moment, notaries can be added to organization only manually through the PandaDoc Notary UI. - Organization must have Notary addon enabled to use this endpointInput Parameters
Output
List notarization requests
List notarization requests
PANDADOC_LIST_NOTARIZATION_REQUESTSList notarization requests. Retrieve a paginated list of notarization requests for your organization. Results can be filtered by status, creator, or document, and sorted by status or by the request’s creation or completion dates. ## Permissions > 🔒 Requirements > > - The Notary On-Demand or Notary add-on must be enabled for your organization. Without an active add-on, the endpoint returns 403 Forbidden. > - The request is executed with the permissions of the API key owner. By default, the response only includes notarization requests created by the API key owner. To list notarization requests created by any user in the organization, the API key owner must have the Can view any notarization request permission. ## Limits A maximum of 100 API calls per minute is permitted. Exceeding this limit triggers a 429 Too Many Requests error.Input Parameters
- prefix for descending order (e.g., -date_created). When omitted, results are sorted by date_created ascending (oldest first).Output
List recent SMS opt-outs
List recent SMS opt-outs
PANDADOC_LIST_RECENT_SMS_OPT_OUTSList recent SMS opt-outs. Retrieves a list of the most recent SMS opt-out changes for each phone numbers used in your workspace. > 📘 You can filter results by time range using timestamp_from and timestamp_to.Input Parameters
Output
List template folders
List template folders
PANDADOC_LIST_TEMPLATE_FOLDERSList template folders. Get the list of folders that contain Templates in your account. > 📘 > > The root folder is not listed in the response. For the full list of folder operations and their limitations, see Organize Templates and Folders.Input Parameters
Output
List Templates
List Templates
PANDADOC_LIST_TEMPLATESThis tool retrieves a list of all templates available in the PandaDoc account. It supports parameters to filter templates by name, shared status, deleted status, pagination, and tag filtering, and returns detailed template information.Input Parameters
Output
List users
List users
List webhook events
List webhook events
List webhook subscriptions
List webhook subscriptions
List workspace members
List workspace members
PANDADOC_LIST_WORKSPACE_MEMBERSList workspace members. Retrieve all members details of the workspace implied by the OAuth token or API key. For each member, the workspace parameter shows their active workspace, that is the workspace they are currently working in. This means the workspace value can differ from the workspace implied by your API key.Output
List workspaces
List workspaces
Move a document to draft
Move a document to draft
PANDADOC_MOVE_DOCUMENT_TO_DRAFTMove a document to draft. Revert your document back to draft to continue editing it. > 📘 Returning to Draft works for any document status except Removed. ## After you move your document to the Draft status - Signature and Initials fields are cleared. All other fields stay filled in. - Recipients are not notified that the document is back in Draft. - You’ll need to resend the document so that recipients can sign the updated version.Input Parameters
Output
Move Document to Folder
Move Document to Folder
PANDADOC_MOVE_DOCUMENT_TO_FOLDERThis tool allows users to move a document to a specific folder within their PandaDoc account. It performs a POST request to move the document to the specified folder. Both the document and the destination folder must exist. Only documents in draft status can be moved; attempting to move documents in sent, completed, or other non-draft states will fail.Input Parameters
Output
Reassign a document signer
Reassign a document signer
PANDADOC_REASSIGN_DOCUMENT_SIGNERReassign a document signer. Reassign fields to another signer. > 🚧 Before you start > > To change a signer in a document, please ensure that: > > - You have the ‘Can Manage Recipients’ permission. > - New signer is already created in your contacts. If not, add them using the Create Contact endpoint. You can reassign fields to another signer before the original signer has signed the document. You can choose any person except those recipients who have already signed the document. The endpoint path includes the recipient_id of the original signer and the request body must include the following two parameters: - kind: Set this parameter to contact to specify an individual contact, or contact_group to specify a contact group. - id: Input the ID of the contact (for kind: contact) or contact group (forInput Parameters
Output
Remove a workspace member
Remove a workspace member
Rename a document folder
Rename a document folder
PANDADOC_RENAME_DOCUMENT_FOLDERRename a document folder. Rename Documents Folder. For the full list of folder operations and their limitations, see Organize Documents and Folders.Input Parameters
Output
Rename a template folder
Rename a template folder
PANDADOC_RENAME_TEMPLATE_FOLDERRename a template folder. Rename a templates folder. For the full list of folder operations and their limitations, see Organize Templates and Folders.Input Parameters
Output
Search Catalog Items
Search Catalog Items
Search product catalog items
Search product catalog items
PANDADOC_SEARCH_PRODUCT_CATALOG_ITEMSSearch product catalog items. This method searches for items in your product catalog. Use the query parameter to search in title, SKU, description, category name, custom fields name and value. You can also search for items by their type, billing type, and category id. Order search results, in both ascending and descending order, by these item properties: - SKU - Name - Price - Modification date Use the exclude_uuids parameter to exclude particular uuids from the search request.Input Parameters
Output
Send a document
Send a document
PANDADOC_SEND_DOCUMENTSend a document. > 🚧 Using the Sandbox Key > > When you use a sandbox API key during the free trial period, the sender and recipient email addresses must be from the same organisation (email domain). ## Document State - You can only send a document in the document.draft status. - After creating a new document, it usually retains a document.uploaded status for 3-5 seconds while the document syncs across PandaDoc servers. When the document is available for further API calls, it moves to the document.draft state. Use Document Status or Webhooks to check document status. - Moving a document to the document.sent status finalizes the document structure, before recipients can complete it. - If a template used for the document creInput Parameters
true, disables email notifications for document recipients and the document sender. Also disables scheduled reminders (manual reminders still possible). Doesn’t affect “Approve document” email notification sent to the Approver.Output
Send a manual reminder
Send a manual reminder
PANDADOC_SEND_MANUAL_REMINDERSend a manual reminder. Sends manual reminders to one or more recipients of a specified document.Input Parameters
Output
Transfer ownership of all documents
Transfer ownership of all documents
PANDADOC_TRANSFER_OWNERSHIP_OF_DOCUMENTSTransfer ownership of all documents. This method transfers ownership of all documents from one member to another.Input Parameters
true, disables the email and in-app notifications about the ownership transfer that are sent to the new documents owner.Output
Update automatic reminder settings
Update automatic reminder settings
PANDADOC_UPDATE_AUTOMATIC_REMINDER_SETTINGSUpdate automatic reminder settings. Configures automatic reminders for document recipients. These reminders are sent after the document’s initial dispatch. Settings include enabling reminders, delivery method (email/SMS), initial delay, and recurrence frequency.Input Parameters
true, reminders are scheduled based on the configuration.true, reminders will be sent repeatedly at specified intervals after the initial reminder.Output
Update a document
Update a document
PANDADOC_UPDATE_DOCUMENTUpdate a document. Use the PATCH method to update a PandaDoc document. > 🚧 Document status > > You can only update a document in the Draft status (document.draft). > > After creating a new document, it usually retains a document.uploaded status for 3-5 seconds while the document syncs across PandaDoc servers. When the document is available for further API calls, the document moves to the document.draft state. Use Document Status or Webhooks to check document status.Input Parameters
Output
Update document field assignments
Update document field assignments
PANDADOC_UPDATE_DOCUMENT_FIELD_ASSIGNMENTSUpdate document field assignments. Assign, reassign, or unassign document fields to recipients. Supports bulk operations by accepting multiple field assignment items in a single request. > 🚧 Before you start > > - The document must be in the ‘Draft’ (document.draft) status. > - You must have the ‘Can Edit Document’ permission.Input Parameters
Output
Update a document quote
Update a document quote
PANDADOC_UPDATE_DOCUMENT_QUOTEUpdate a document quote. This operation updates the details of a specific quote within a document by specifying the document ID and quote ID. > 📘 Permissions > > Requires the ‘Can Edit Document’ and ‘Can Edit Content’ permissions. > The document must be in Draft (document.draft). > Updating quotes is available on plans that include > Product Catalog. > 🚧 Payload size > > The maximum request body size is 512 KiB (524288 bytes). Larger requests return 413 and are not applied.Input Parameters
Output
Update a document recipient
Update a document recipient
PANDADOC_UPDATE_DOCUMENT_RECIPIENTUpdate a document recipient. Modify a recipient’s personal details, or update a recipient group’s name and members. > 🚧 Before you start > > To edit a recipient, please ensure that you have the ‘Can Edit Document’ permission. Use this endpoint to easily fix typos in a recipient’s name or email, or to change any other recipient information in a sent document. ### Editing a recipient group When the recipient_id points to a recipient group, you can rename the group and/or change its members: - Send name to rename the group. - Send members to replace the group’s membership. The list you send becomes the group’s new full membership: members you omit are removed, and new entries are added. Members are matched by email; for a retained member, only the contact fields you include (first_name, last_name) are updated, and omitted fields keep their existing values. -Input Parameters
Output
Update document settings
Update document settings
PANDADOC_UPDATE_DOCUMENT_SETTINGSUpdate document settings. Updates the settings for a specified document.Input Parameters
true, recipients can suggest edits to the document content. Can only be changed while the document is in draft status.true, signers must complete the document using a third-party qualified electronic signature provider according to supported verification rules.Output
Update a product catalog item
Update a product catalog item
Update a template
Update a template
PANDADOC_UPDATE_TEMPLATEUpdate a template. Update a template. Currently supports updating template variables (tokens) and managing template roles. > 🚧 Template status > > You can only update a template in the PROCESSED status (template.PROCESSED). > > After creating a new template, it usually retains a template.uploaded status for 3-5 seconds while the template syncs across PandaDoc servers. When the template is available for further API calls, the template moves to the template.PROCESSED state. Use Template Status or Webhooks to check template status. ## Managing template roles Pass a roles array to replace the full set of template roles in a single request: - Items with an existing id update that role (name, signing_order). - Items without an id create a new role. - Existing roles whose id is not inInput Parameters
id are updated, items without an id are created as new roles, and existing roles whose id is not present in the list are deleted.Output
Update template settings
Update template settings
PANDADOC_UPDATE_TEMPLATE_SETTINGSUpdate template settings. Updates the settings for a specified template. Only the language field is currently supported.Input Parameters
Output
Update template sharing settings
Update template sharing settings
PANDADOC_UPDATE_TEMPLATE_SHARING_SETTINGSUpdate template sharing settings. Replaces the full list of Workspaces this Template is shared with. The caller must be a member of every Workspace being newly shared by this call. Unsharing a Workspace only requires permission to edit the Template.