Generate and Send for SFTP

Using High Volume Document Generation API, you can generate PDFs and send them via SFTP.

Prerequisites

A valid and active Conga Advantage Platform organization.
ClientID and Secret generated and implemented. See Authorizing High Volume Document Generation.
SFTP services configured and functional.

Use Case

In this use case, we use an HMTL template to merge with data from CSV or JSON data, convert it to PDF format, and then email it via Conga Advantage Platform through SFTP

Step 1: Create an HTML Template

Create an email template on using the HTML Editor. Once done, copy the template's file ID. For more information on how to create a template and get the File ID, see the following topics:

Step 2: Configure SFTP

In order to send through SFTP, you must connect your SFTP delivery integration. For details on how to configure SFTP, refer to Configuring Composer Platform Integration and refer to the section on Document Delivery integration.

Step 3: Create the Merge Request

Create a merge request to generate the document. The merge request contains several parameters that determine which features are included in the generated document. An example of the parameters as they appear in JSON is as follows:{ "dataFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "templateIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "format": "Json", "useSFTP": true, "sftpFolderName": "user/dev/foldername" }

Call the following High Volume Doc Gen API method to create the document:


Method	POST
Request Endpoint	`https://coreapps-rlspreview.congacloud.com/api/highvolumemerge/v1/merge`
Request Body	{ "dataFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "templateIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "format": "Json", "useSFTP": true, "sftpFolderName": "dev/foldername" }
Example JSON File data	[ { "Id": "a24c9f37-0456-4623-a2de-459b8f5e1221", "DocumentOptions": { "OutputName": "contract.pdf" }, "Data": { "CONTACT_FIRSTNAME": "Oliver", "OPPORTUNITY_NAME": "Cloud Solution Partnership", "ACCOUNT_NAME": "Acme Inc", "Conga_Doc_Link": "https://example.com/doc1", "USER_FIRSTNAME": "Daniel", "USER_NAME": "Daniel Smith", "USER_TITLE": "Senior Manager", "USER_CUSTOM_ORG_NAME": "Smith Consulting", "USER_PHONE": "555-123-4567", "USER_EMAIL": "daniel.smith@example.com", "OppLineItems": [ { "PRODUCT_NAME": "Service Plan", "OPPORTUNITY_LINEITEM_UNITPRICE": "$200", "OPPORTUNITY_LINEITEM_QUANTITY": 10, "OPPORTUNITY_LINEITEM_TOTALPRICE": "$2000" }, { "PRODUCT_NAME": "Consultation", "OPPORTUNITY_LINEITEM_UNITPRICE": "$500", "OPPORTUNITY_LINEITEM_QUANTITY": 5, "OPPORTUNITY_LINEITEM_TOTALPRICE": "$2500" } ] }, } ]

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.