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: 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" ], "emailTemplateId": "", "emailProvider": "none", "format": "Json", "useCongaSign": false, "useSFTP": true, "sftpFolderName": "user/dev/foldername" }

You can control the values of the document generation by including the values in the merge API request body:

dataFileId: Required for the document to generate. It must contain the ID of a selected data file.
TemplateIds: Required for the document to generate. It must contain the ID of a selected template. Only one template ID is supported at this time.
Format: The value of the format must be set to either JSON or CSV, depending on your data file.
EmailProvider: This value must be set to None in order to work with SFTP.
EmailTemplateID: SFTP does not utilize an Email Template ID and should be blank.
useCongaSign: As this is not a Conga Sign integrated solution, this value must be set to false. For details on using high volume document generation with Conga Sign, refer to Generate and Conga Sign documents.
useSFTP: This must be set to true and sftpFolderName must contain a value.
1. SFTPFolderName: Required for use with SFTP integration. The folder path and name where the generated documents will be stored. Example: "user/dev/Coreapps".

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


Endpoint	https://coreapps-rlspreview.congacloud.com/api/highvolumemerge/v1/merge
Request Method	Post
Request Body	{ "dataFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "templateIds": [ "3fa85f64-5717-4562-b3fc-2c963f66afa6" ], "emailTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "emailProvider": "None", "format": "Json", "useSFTP": true, "sftpFolderName": "dev/foldername" }

Step 3: Check Merge Request Status

Once the documents begin to merge and send, you can verify the status of the process by checking against the batchId of the merge using the following API settings.


End Point	https://coreapps-rlsprod.congacloud.com/api/highvolumemerge/v1/status/{{batchId}}
Request Method	GET
Body	{ "batchId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "string", "totalJobs": 0, "inProcessJobs": 0, "completedJobs": 0, "failedJobs": 0, "avgMergesPerMinute": 0, "avgTimePerMergeMilliseconds": 0, "elaspedTime": "string", "lastUpdated": "2025-01-30T05:44:21.348Z" }

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.