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.

Show Page Sections

download

Retrieve Status for High Volume Merge Requests

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

You will need to get the batchID of the merge in question and add that into the Request Endpoint. This id will be the result of a successful merge operation.

For example, running a Generate and Email document successfully with provide the following:
Code: 200Successful Operation
Body{ "batchId": "82e44b05-a8e3-454d-930a-a3e6f0b201ea" }

Retrieve Status of High Volume Merge Batch

Input the batchId value in the endpoint to retrieve the merge status:
MethodGET
Request Endpointhttps://coreapps-rlspreview.congacloud.com/api/highvolumemerge/v1/status/{{batchId}}
Body{ "batchId": "82e44b05-a8e3-454d-930a-a3e6f0b201ea", "status": "Completed", "totalJobs": 1, "inProcessJobs": 0, "completedJobs": 1, "failedJobs": 0, "avgMergesPerMinute": 25, "avgTimePerMergeMilliseconds": 2342, "elaspedTime": "00:00:02", "lastUpdated": "2025-01-30T05:44:21.348Z" }

Download High Volume Batch Summary

To download a summary of high volume merge status, you can include the summary value after the batchId:

MethodGET
Request Endpointhttps://coreapps-rlspreview.congacloud.com/api/highvolumemerge/v1/status/{{batchId}}/summary