Footer Section
Explore
Adobe Sign ServicesAdvantage Platform AdministrationApprovals for Advantage PlatformApprovals for SalesforceBilling for Advantage PlatformBilling for SalesforceCLM for Advantage PlatformCLM for SalesforceContracts for SalesforceCollaborateComposer for Advantage PlatformComposer for SalesforceContractsConga for Google DocsConga Upgrade ProgramContract Intelligence (Standalone)Conga CopilotCPQ for Advantage PlatformCPQ for SalesforceDeal MaximizerDigital Commerce for Advantage PlatformDigital Commerce for SalesforceDiscovery AI for Advantage PlatformDiscovery AI for SalesforceDocusign ServiceseSignature Integration with Advantage PlatformGridInvoice GenerationMix FormsOrchestrateOrder Management for Advantage PlatformOrder Management for SalesforcePartner Commerce for Advantage PlatformPartner Commerce for SalesforceQuote GenerationSign for Advantage PlatformSign for SalesforceSmart SearchTest AuthorTurboEnginesX-Author for Contracts 1.0 (Classic)X-Author for ContractsX-Author for Contracts Advanced for Advantage PlatformX-Author for Contracts Advanced for SalesforceX-Author for ExcelX-Author for Migration Manager for Advantage PlatformX-Author for Migration ManagerRelease NotesGeneral
Export a document
post
https://IDD_URL/idd/api/{version}
/{tenantId}/analyze/export
Exports a document based on the settings given in the request body's Payload object.
For requests with automatic notification enabled (that is, with the notificationInfo object included in the request), the request body in the notification resembles:
status: complete,
responseBody:
is_successful: true,
redirect_href: https://ca.app.kirasystems.com/platform-api/v1/downloads/3625/files,
downloadId: 3625
tenantId
stringTenant name
documentid
stringDocument ID
format
stringFile format
Allowed values:
pdfwordexcel
instanceurl
stringInstance URL
userid
stringUser ID
Example:
a56392269d970c
username
stringUser name
Example:
dummyuser
Request for export. If notificationInfo is included, polling is performed for export completion.
payload
objectexport_format
stringExample:
pdf
include_highlight
booleanExample:
false
pdf_quality
stringExample:
low
notificationInfo
objectIncluding this webhook information enables automatic polling by IDD.
url
string<string>URL
Example:
https://www.conga.com/maxupload/notify
method
string<string>Request method
Example:
POST
:
:
::::::
curl --request POST \--url 'https://idd_url/idd/api/v2/tenantId/analyze/export?format=pdf' \--header 'Accept: application/json' \--header 'Content-Type: application/json' \--header 'X-API-Key: 123' \--data '{"payload": {"export_format": "pdf","include_highlight": false,"pdf_quality": "low"},"notificationInfo": {"url": "https://www.conga.com/maxupload/notify","method": "POST"}}'
1{2"jobId": "4839",3"documentId": "83920",4"context": {5"instanceUrl": "https://www.conga.com"6}7}
chevron_right