The High Volume Document Generation Use cases each follow similar structures with different settings. The structure of each should follow this format:

{
  "dataFileId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "templateIds": [
    "3fa85f64-5717-4562-b3fc-2cE963f66afa6"
  ],
  "emailTemplateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "emailProvider": "CongaPlatform",
  "format": "Json",
  "useCongaSign": true,
  "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:

1. dataFileId: Required. It must contain the ID of a selected JSON or CSV data file. JSON files work with downloading, email, SFTP and Conga Sign solutions. CSV does not work with Conga Sign.

2. TemplateIds: Required for the document to generate. It must contain the ID of a selected template.

   Note: Although this value is set in an array, only one template ID is supported at this time.

3. Format: The value of the format must be set to either JSON or CSV, depending on your data file and solution.

4. EmailProvider: Currently, the only supported email provider for high volume document generation is CongaPlatform. Use when sending an email. This element can be removed if you are not using an Email solution.

5. EmailTemplateID: The ID value of an HTML email template to send to your recipients, and is an optional element when sending with Conga Sign. In order to send an email with the merge documents, this field must contain an ID value. This element can be removed if you are not using an email or Conga Sign solution.

6. useCongaSign: Required in order to send high volume documents with Conga Sign. If using Conga Sign, you must set this value to true. This element can be removed if you are not using Conga Sign in your solution.

7. useSFTP: Required if you are sending documents using SFTP. This must be set to true and sftpFolderName must contain a value. This element can be removed if you are not using an SFTP solution.

   1. SFTPFolderName: Required for use with SFTP integration. The file path and name where the generated documents will be stored. Example: "user/dev/HighVolume". This element can be removed if you are not using an SFTP solution.