Generate and Conga Sign documents

High Volume Document Generation can be integrated with Conga Sign to send out documents for signature.

Prerequisites

A valid and active Conga Advantage Platform organization.
A valid and active Conga Sign for Advantage Platfo
ClientID and Secret generated and implemented. See Authorizing High Volume Document Generation.

Use Case

In this use case, we use an HMTL template to merge with data from JSON data, convert it to PDF format, and then email it via Conga Sign for Conga Advantage Platform.

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": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "emailProvider": "None", "format": "Json", "useCongaSign": true, "useSFTP": false, "sftpFolderName": "null" }

You can control the values of the document generation by including the values in the merge API request body. In order to pass this information to Conga Sign successfully, the value of useCongaSign must be set to "true":

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 JSON. CSV files are not supported for Conga Sign integration.
EmailProvider: To send with Conga Sign, this value must be set to "none".
EmailTemplateID: The Id of the email template to send to your recipients. This value is optional when used with Conga Sign.
useCongaSign: To send high volume emails with Conga Sign, this must be set to true.
useSFTP: In this example, we are not using secure file transfer protocols and the value is set to false. For details on using high volume document generation with SFTP, refer to Generate and Send for SFTP.
1. sftpFolderName: As we are not using SFTP, this value may contain either "null" or placeholder text.

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


Endpoint	https://rls-dev.congacloud.io/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", "useCongaSign": true, "useSFTP": true, "sftpFolderName": "string" }
Response Body	{ "errors": [ { "status": 0, "title": "string", "detail": "string" } ] }

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" }
Errors	{ "errors": [ { "status": 0, "title": "string", "detail": "string" } ] }

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.