For AI agents: the docs index is at https://developer.conga.com/doc-automation/llms.txt. The index for every project on this site is at https://developer.conga.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Document AutomationProduct DocumentationConga Community
HomeAPI Reference
Product DocumentationConga CommunityLog InDocument Automation
API Reference
Log In
HomeAPI Reference

Ingress

  • Auth
    • Exchange a Salesforce authorization code for a sessionpost
    • Check the current sessionget
    • Logs out the user by clearing the session cookie and any other relevant cleanup.post
  • Documents
    • Generate a document from merge templates and data sourcespost
    • Join documents from multiple sourcespost
    • Change document protectionpost
    • Change document protectionpost
    • Convert documents' formatpost
    • Convert a document's formatpost
    • Process documentspost
    • Process a documentpost
  • Jobs
    • Get job informationget
  • Template Generation
    • Start an AI template generation jobpost
    • Stream template generation eventsget
    • Answer a template generation questionpost
  • Status
    • Get merge process statusget
    • Get merge process status (v2 API with standardized error response)get
  • Document Conversion
    • Converts the uploaded document to a PDF stream.post
    • Converts an uploaded Word document (.doc or .docx) to a CKEditor-compatible HTML body fragment.post
  • Salesforce
    • Search Salesforce Leads, Contacts and Usersget
    • Get Salesforce Object Name and Object Type by Record IDget
    • Fetch managed package Salesforce templates for the current customer's org.get
    • Retrieves recent attachments and files for a Salesforce record(objectId) with pagination, search, and filtering support.get
    • Fetch related contacts for a given Salesforce record.get
    • Preview a template file (PDF rendition) streamed from Salesforce Connect API. Supports multiple render types: PDF, HTML, DOC, DOCX, XLS, XLSX, PPT, PPTX.get
    • Retrieves sample records for a specified Salesforce master object.post
    • Fetch a specific set of Salesforce templates by their selectors.post
    • Batch fetch multiple Salesforce attachments/files that belong to a Salesforce record (objectId) by their IDs in a single request. Mirrors GET /v1/Salesforce/attachments/{objectId}: the objectId is validated and its existence verified before the supplied IDs are resolved. IDs that do not match any record are silently omitted.post
    • Download the original template file streamed from Salesforce. Serves as the fallback when the preview endpoint cannot render a template inline (legacy Salesforce Attachments and non-previewable ContentDocument file types). The original filename and content type are preserved via the response headers.get
    • Retrieves master objects from Salesforce based on the provided criteria.post
    • Builds a hierarchical tree of merge fields for a given Salesforce master object ID, reference object IDs, and Conga query IDs.post
    • Returns the calculated (formula) String fields of a Salesforce object, for the DTS expression picker.get
    • Resolves the Salesforce {!...} merge fields in a solution's Composer button URL and returns the resolved URL, so the caller can prepend the hostname and open the merge UI.post
  • Merge
    • Get merge infoget
    • Accept mergeget
    • Reject mergeget
    • Initiate the merge workflowpost
    • Initiate the merge workflow after uploading JSON datapost
    • Returns the url list of merged and preview documents for a given correlationId.get
    • Trigger deferred post-merge operationspost
  • Email
    • Send an email with attachments using providers such as SES, Salesforce (SF), or SendGridpost
    • Merge an email template with SF info or JSON payload from original merge requestpost
    • Generate sign package urlpost
  • Configuration
    • Retrieves environment and region details from configuration.get
  • MergeTemplates
    • Gets the list of available merge templates with optional pagination.get
    • Creates a new merge template entry based on the provided request data.post
    • Gets a single template by Id.get
    • Deletes a merge template by Id.del
    • Updates an existing merge template by Id.patch
  • Queries
    • Retrieves all queries.get
    • Creates a new query based on the provided request.post
    • Gets the query by identifier.get
    • Deletes a query based on the provided query ID.del
    • Updates a query based on the provided query ID and update request.patch
  • Preview
    • Merges the provided dataModel with the template to generate a preview.post
  • PlatformComposerFeatureFlag
    • Evaluate PlatformComposer feature flag for the given Salesforce Org Id. This endpoint is anonymous because we're applying Salesforce IP restriction rule in our WAF. It's very light endpoint used to evaluate LaunchDarkly feature flags and used currently during migration to PlatformComposer.get
  • Orchestrate
    • Run an Orchestrate mergepost
    • Run an Orchestrate merge (query-string variant)get
  • OrchestrateOauth
    • OAuthProxy endpoint serves a self-contained HTML page that initiates the PKCE OAuth flow in the browser.get
    • Starts the OAuth PKCE flow by generating a code verifier/challenge, storing the verifier in Redis, and redirecting to the Salesforce authorization endpoint.get
    • Handles the OAuth callback from Salesforce. Salesforce redirects here with code + state. Consumes the PKCE verifier from Redis, exchanges code + verifier for tokens, and establishes the connection.get
    • Gets the connection status for Orchestrate.get
    • Revokes the Orchestrate connection.del
  • OrchestrateV3
    • Run an Orchestrate merge (HMAC-authenticated)post
  • Migration
    • Runs the ComposerSolution status migration job. Finalized records using status "Draft" will be updated to "Complete".post
  • Json
    • Get data Schema JSONpost
    • Translate JSON datapost
  • EmailTemplates
    • Gets all email templates for the caller's flow, with optional search, sorting and pagination.get
    • Gets the email template by identifier.get
  • Draft
    • Saves a solution draft before it proceeds to the Deploy tab.post
    • Retrieves a draft solution by its ID.get
  • Solution
    • Retrieves all solutions with optional pagination, filtering, and sorting.get
    • Creates a new solution.post
    • Retrieves the code snippet for a specific language and solution.post
    • Retrieves a single solution by its ID.get
    • Partially updates an existing solution by its ID (PATCH).patch
    • Deletes a solution by its ID.del
    • Get coding languages for the solution's deploy stepget
    • Search Saleforce contacts with the given search term.get
    • Publishes (CREATE) or re-publishes (UPDATE) the Salesforce WebLink for this solution. The solution is read from and written back to MySQL/TiDB; the WebLink is deployed via the Salesforce Metadata SOAP API (createMetadata/updateMetadata). The post-create record id and uniqueness checks use the Tooling REST query endpoint. CREATE vs UPDATE is decided by the stored ButtonBodyField. Salesforce authentication is required.post
    • Generates a live preview of the Conga Composer button URL from unsaved Solution data.post
    • Preview the data for a solution by its ID. The preview record is the solution's stored sample record; the request has no body.post
  • Datasources
    • Get a combined data schemaget
    • Return a combined data schemapost
  • CustomBranding
    • Uploads a logo file with a custom name.post
    • Get all uploaded customBrandingsget
    • Delete a custom branding recorddel
    • Updates a logo's image and/or custom name by ID.patch
    • Get logo file details by IDget
    • Download a logo fileget
  • ComposerParameter
    • Retrieves all parameters with optional pagination and search filter.get
    • Get a parameter by IDget
    • Retrieves parameters that belong to a given category, resolved by either its id or name.get

Approvals

  • Activities
    • Get approval activities for a context objectget
    • Query approval activities for a context objectpost
  • AdhocProcess
    • Define an ad hoc processpost
    • Get an ad hoc processget
    • Delete the adhoc Approvalsdel
    • Submit adhoc approvalpost
    • Resubmit an ad hoc processpost
    • Get a submitted ad hoc processget
  • AsyncOperationStatus
    • Get Async Operation Status by correlation idget
  • BackupAdmin
    • Get the backup administratorget
    • Save the backup administratorpost
    • Delete the backup administratordel
  • BackupDelegates
    • Create or update backup or delegate approverspost
    • List backup and delegate approversget
    • Get a backup or delegate approverget
    • Delete a backup or delegate approverdel
    • Count backup and delegate approversget
    • Activate a backup or delegatepost
    • Deactivate a backup or delegatepost
  • BusinessObjects
    • List business object typesget
    • List all business objects' assignee type valuesget
    • List a business object's assignee type valuesget
    • List a business object's custom user fieldsget
    • Validate a custom assigneepost
    • List a business object's fieldsget
    • Get a business object's child typesget
    • List a business object's processesget
    • Reorder an approval process listpost
    • Get a business object's rulesget
    • Count all of a business object's rulesget
    • List all available email templatesget
    • List email templates for a specific business object typeget
    • List email templates filtered by categoryget
    • List email templates for business object and categoryget
  • Process
    • Create an approval processpost
    • Search approval processesget
    • Get an approval processget
    • Update an approval processput
    • Delete an approval processdel
    • Activate an approval processpost
    • Deactivate an approval processpost
    • Clone an approval processpost
    • Reorder a list of approval processespost
    • Get this step's dependenciesget
    • List all step dependenciesget
    • Update an approval process step by IDput
    • Delete an approval process stepdel
    • Reorder approval process stepspost
    • Get approval process stepsget
    • Activate an approval process steppost
    • Deactivate a process steppost
    • Check for a processget
    • Count active and inactive processesget
  • ProcessSteps
    • Create an approval process steppost
    • Update an approval process stepput
    • Get an approval process stepget
    • Check for a stepget
  • Requests
    • Submit for approvalpost
    • Submit approval requests asynchronouslypost
    • Get an approval request statusget
    • Preview an approvalget
    • Approve a requestpost
    • Approve requestspost
    • Reject an approval requestpost
    • Reject approval requestspost
    • Reassign requestspost
    • Escalate an approval requestpost
    • Reassign an approval requestpost
    • Add an ad hoc approverput
    • Delete an ad hoc approverdel
    • Add comment to approval requestput
    • Reqeust an information about approval requestput
    • Check for objects requiring approvalpost
    • Check for objects requiring approval asynchronouslypost
    • Process escalation reminder jobspost
    • Get status for a context objectget
    • Get child object approval statusget
    • Recall approval requestspost
    • Get approval request commentsget
    • Perform Bulk Approval Actionspost
    • Get an approval requestget
    • Get the approval request attachmentspost
    • Get requests by assignee and object IDget
    • Take ownership of an approval requestput
    • Get reassign targets for an approval requestget
  • RuleDimensions
    • Save an approval rule dimensionpost
    • Get an approval rule dimensionget
    • Update an approval rule dimensionput
    • Delete an approval rule dimensiondel
  • RuleEntries
    • Save an approval rule entrypost
    • Get an approval rule entryget
    • Validate a rule entry labelget
    • Reorder rule entriespost
  • Rules
    • Save an approval rulepost
    • Search rulesget
    • Get an approval ruleget
    • Delete an approval ruledel
    • Activate an approval rulepost
    • Deactivate an approval rulepost
    • Clone an approval rulepost
    • Get rule entry dependenciesget
    • Activate an approval rule entrypost
    • Deactivate an approval rule entrypost
    • Delete an approval rule entrydel
    • Validate a rule nameget
  • SearchFilters
    • Create or update a search filterpost
    • Get all search filtersget
    • Get a search filter by IDget
    • Delete a search filter by IDdel
    • Activate a search filterpost
    • Deactivate a search filterpost
    • Validate a search filter nameget
  • SystemProperties
    • Get system propertiesget
    • Update system propertiespost
    • Get a custom configurationget
    • Delete a custom configurationdel
    • Create or update a custom configurationpost
    • Get custom configurationsget
    • Get all business object product settingsget
    • Get email configurationget
    • Create email configurationpost
    • Update email configurationpatch
  • UserDashboard
    • Count user's approvalsget
    • Get Approval Count for BusinessObjectget
    • Get dashboard approvals and business object datapost
    • Get user dashboard approval detailsget
  • UserGroup
    • List user groupsget
    • Create a user grouppost
    • Update a user groupput
    • List a user group's membershipget
    • Delete a user group by IDdel
    • List user group membersget
    • Add a memberpost
    • Delete a member by IDdel

eSignature

  • AdobeSign
    • Get Adobe sign events by esign transactionget
  • AgreementSigningCycle
    • Retrieves a list of agreement signing cycles based on the specified signing provider type and agreement ID.get
  • Authorization
    • Get refresh tokenpost
    • Get access tokenget
  • Configuration
    • Get sign configurationget
    • Update the sign configurationput
    • Set the default sign providerpost
    • Activate a sign providerpost
  • CongaSign
    • Create and send a transactionpost
  • HealthCheck
  • HealthCheck
  • Sign
    • Create an envelopepost
    • Get transaction details by transactionget
    • Get transaction details by object IDget
    • List allowed signer typesget
    • List usersget
    • End wet-sign flowpost
    • Get sign provider templatesget
    • /api/esign/v1/esignatures/void/{objectId}post
    • Get the latest sign providerget
    • Get event logs by package IDget
    • Get all event logs with paginationget
    • Get recipient details by external eSign idget
    • Get sign provider template detailget

Conga Sign

  • AccountAttachmentsBlacklist
    • Retrieves a list of blacklisted attachment types.get
  • AccountAttachmentsWhitelist
    • Retrieves your current attachments whitelist.get
    • Updates your attachments whitelist.put
    • Deletes and resets attachments whitelist.del
  • AccountDesignerSettings
    • Retrieves your current Designer settings. Retrieved values include any customizations you may have made, as well as any current default values.get
    • Updates your account Designer settings. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changes.patch
    • Deletes any Designer settings that you may have configured. Your Designer settings will be returned to their default values.del
  • AccountEmailReminderSettings
    • Retrieves your current Email Reminder settings.get
    • Updates your account email reminder settings.patch
    • Deletes any customized Account Email Reminder settings.del
  • AccountFeatureSettings
    • Retrieves a list of all your current Backoffice Feature settings.get
    • Updates your Backoffice Feature settings with any or all changes. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changes.patch
    • Deletes and resets any customized Backoffice Feature settings.del
  • AccountPackageSettings
    • Retrieves a list of all your current Backoffice Package Settingsget
    • Updates your Backoffice Package settings with any or all changes. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changespatch
    • Deletes and resets any customized Backoffice Package settingsdel
  • AccountRoles
    • Retrieve account role informationget
    • Create a new account rolepost
    • Update an account roleput
    • Retrieve an account roleget
    • Delete an account roledel
    • Retrieve user IDs assigned to a roleget
    • Get the user's account rolesget
    • Create a new account rolepost
  • Accounts
    • Retrieve account usage informationget
  • AccountSettings
    • Retrieves a list of all your current Backoffice Account settings.get
    • Updates your Backoffice Account settings with any or all changes. This call can be used to implement either some of the settings that you wish to change, or to implement all of your changes.patch
    • Deletes and resets any customized Backoffice Account settings.del
  • AccountSigningLogos
    • Add, update, or delete signing ceremony logosget
    • Retrieve an account's signing ceremony logospost
  • AccountSigningTheme
    • Retrieve a customized signing themeget
    • Create a customized signing themepost
    • Update a customized signing themeput
    • Delete customized signing themesdel
  • AccountSigningUIOptions
    • Retrieve customized new signer experience settingsget
    • Patch custom signing UI optionspatch
    • Delete customized new signer experience settingsdel
  • AccountSupportedLanguages
    • Retrieves the list of supported languages that you can set for your signers.get
    • Updates your supported signing languages.patch
    • Deletes your personally configured supported signing language settings.del
  • AccountSystemSettings
    • Retrieves your current system settings.get
    • Update your system settings with new settings.patch
    • Deletes and resets any customized system settings.del
  • Approval
    • Create an approvalpost
    • Update an approvalput
    • Retrieve an approvalget
    • Update an approvalput
    • Delete an existing approvaldel
    • Create a new field with an autogenerated name related to an existing approvalpost
    • Retrieve an approval fieldget
    • Update a field related to an approvalput
    • Create a field related to an approval with a specific field IDpost
    • Delete a field from an approval.del
    • Updates the conditions for a given approval fieldput
    • Retrieve all signable approvalsget
  • AuthenticationTokens
    • Create a sender authentication tokenpost
    • Create a multi-use signer authentication tokenpost
    • Create a new single use signer authentication tokenpost
    • CONGA-ONLY Creates a User access token that is used to access package details for a signer of an existing package. This single-use token is restricted to a single package and expires after 30 minutes.post
  • Callback
    • Retrieves a list of all callbacks.get
    • Creates a new callback.post
    • Retrieves a list of callbacks for a specified connector.get
    • Creates a new callback for a specified connector.post
  • ComprehensiveHealthCheck
    • Checks for comprehensive healthget
  • CustomerOnboarded
    • Get Customer Onboardedget
  • CustomerRegistration
    • CONGA-ONLY Delete OneSpanCallback Customer Registrationdel
    • CONGA-ONLY Register OneSpanCallback Customer Informationpost
    • CONGA-ONLY Get OneSpanCallback Customer Informationget
  • CustomFields
    • Create a custom fieldpost
    • List all custom fields. Query parameters "to" and "from" are expected to navigate pages.get
    • Update a custom fieldput
    • Delete a custom account field by IDdel
    • Retrieve an account specified custom fieldget
  • CustomSettings
    • Get current custom settingsget
    • Update custom settingsput
  • DataManagement
    • Retrieve the data management policy for the accountget
    • Update the account's data management policyput
    • Retrieve the expiry configurations defined for the accountget
    • Update the expiry configurations defined for the accountput
  • Documents
    • Retrieve the specified documentget
    • Update a documentpost
    • Update the specified documentput
    • Delete a document from a packagedel
    • Retrieve zipped documentsget
    • Retrieve document visibility informationget
    • Update document visibilitypost
    • Retrieve an original PDF documentget
    • Retrieve a specific document in PDF formget
    • Retrieve a pageget
    • Add a new document to an existing packagepost
    • Update documentsput
    • Delete multiple documents from a packagedel
    • Create a signature confirmationpost
    • Sign all documents in a packagepost
    • Apply a layout to a documentpost
    • Retrieve zipped file containing all documents including supporting documentsget
    • Replace approvals and imprint fields for a documentput
    • Update document custom metadataput
  • ExternalAuthentication
    • Retrieve external authentication optionsget
  • FastTrack
    • Create a Fast Track transactionpost
  • FileAttachment
    • Download all attachmentsget
    • Download all attachments for a specific roleget
    • Download an attachmentget
    • Add an attachmentpost
    • Delete an attachment filedel
    • Download an attachmentget
    • Check for a specific attachmentget
    • Check for signer uploadsget
    • Check for attachments and uploads by roleget
  • IdvEvidenceSummary
    • Get IDV evidence summaryget
    • Get IDV evidence summary image URLsget
    • Get IDV evidence summary signer imageget
  • IdvWorkflow
    • Retrieve the IDV authentication workflowget
    • Create an IDV authentication workflow configurationpost
    • Update IDV workflow configurationput
    • Delete IDV workflow configurationdel
  • IFWorkflowConfiguration
    • Retrieve IF workflow configuration informationget
  • ImprintFields
    • Creates new imprint field with an autogenerated id.post
    • Deletes all imprint fields assigned to the document.del
    • Replaces all imprint fields with those provided in the request.put
    • Retrieves existing imprint field.get
    • Deletes existing imprint field.del
    • Update existing imprint field.put
    • Copies the imprint field to the other documents in the package.post
  • InAppReports
    • Retrieve reports by date and typeget
    • Delete the specified report files (csv)del
    • Retrieve report summaries by date and report typeget
    • Retrieve a report file (csv)get
    • Delete a report file by ID (csv)del
    • Retrieve zipped csv reportsget
  • Layout
    • List available layoutsget
    • Create a new layoutpost
  • Notification
    • Re-send a notification to a signerpost
    • Re-send a notification to a signerpost
    • Send an SMS notification to signers linked to a rolepost
    • Send an SMS notification to signers linked to a rolepost
    • Send mobile notificationpost
  • OAuth2
    • List all OAuth2 clientsget
    • Create a new OAuth2 clientpost
    • Delete an OAuth2 clientdel
    • Regenerate OAuth2 client secretpost
    • Generate an OAuth2 access tokenpost
  • OneSpanPackage
    • List packagesget
  • OneSpanUrl
    • Retrieves OneSpan BaseURL for different regionsget
  • Package
    • List packagesget
    • Create a packagepost
    • Get package informationget
    • Update a packageput
    • Delete a packagedel
    • Get package readinessget
    • Get package audit detailsget
    • Summarize package evidenceget
    • List package fieldsget
    • /v1/cs-packages/{packageId}/referencedConditionsget
    • Retrieve all approvals by signerget
    • Get package signing statusget
    • Get package signature URLget
    • Create packagespost
    • Re-create a package or templatepost
    • Get package signing URLsget
  • PasswordPolicy
    • Retrieve password policy informationget
    • Update password policy configurationput
  • Reminder
    • Retrieve a package's reminder scheduleget
    • Create a reminder schedulepost
    • Update a reminder scheduleput
    • Delete a reminder scheduledel
  • Reports
    • Report this sender's usageget
    • Report completions by senderget
    • Report senders' usage for this accountget
    • Retrieve a usage report of transactionsget
    • Report transaction details for transactionIdget
    • Report current sender's usageget
  • Role
    • Retrieve all package rolesget
    • Add new rolepost
    • Reorder package rolesput
    • Adds a new ad hoc group to a transactionpost
    • Updates a transaction's existing ad hoc groupput
    • Deletes a specified ad hoc groupdel
    • Retrieve a roleget
    • Update roles in the packageput
    • Delete a roledel
    • Unlock a rolepost
  • RolesVerification
    • Retrieve information on verification types being usedget
    • Update an advanced verification methodput
    • Create advanced verificationpost
    • Delete an advanced verification methoddel
    • Retrieve advanced verification typesget
  • Sender
    • List users in an accountget
    • Create a userpost
    • Retrieve a user's detailed account informationget
    • Update a sender's detailspost
    • Delete a senderdel
    • Invites a user to join the account.post
    • Updates a Sender's password.post
    • Resets the password for a specified user.post
    • Retrieve a user's signatureget
    • Upload a signature imagepost
    • Delete a signature imagedel
  • Session
    • Retrieve session objectget
  • SignatureImage
    • Retrieve signature image for a package roleget
  • SignatureLayout
    • Retrieve signature layout configurationget
    • Update signature layout configurationpatch
  • SignWorkerLogs
    • Get Sign Worker logs by Package IDget
    • Get all Sign Worker logs with paginationget
  • SubAccounts
    • List sub-accountsget
    • List API keys for the current sub-account userget
    • List sub-accountsget
    • Create a new sub-accountpost
    • Update a sub-accountput
  • VirtualRoom
    • Retrieve a virtual room configurationget
    • Update a virtual room configurationput
    • List masked fieldsget
    • Define fields to be maskedpost
    • Add a masked fieldput
    • Delete a masked fielddel
    • List available virtual room recordingsget
    • Fetch a video fileget

HealthCheck

Monitor the overall health of the Conga eSignature services

Updated 21 days ago


Create and send a transaction
HealthCheck
Did this page help you?

Updated 21 days ago


Create and send a transaction
HealthCheck
Did this page help you?
© 2025 All Rights Reserved | Conga.com | Legal | Contact Support | System Status