Jump to Content
Product Documentation
Conga Community
Home
Guides
API Reference
Product Documentation
Conga Community
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
Home
Guides
API Reference
Create a user group
Search
JUMP TO
Approvals
Activities
Get approval activities for a context object
get
AdhocProcess
Define an ad hoc process
post
Get an ad hoc process
get
Save an ad hoc process
post
Resubmit an ad hoc process
post
Ad hoc process inflight edit
post
Get a submitted ad hoc process
get
BackupAdmin
Get the backup administrator
get
Save the backup administrator
post
Delete the backup administrator
delete
BackupDelegates
Create or update backup or delegate approvers
post
List backup and delegate approvers
get
Get a backup or delegate approver
get
Delete a backup or delegate approver
delete
Count backup and delegate approvers
get
Activate a backup or delegate
post
Deactivate a backup or delegate
post
BusinessObjects
List business object types
get
List all business objects' assignee type values
get
List a business object's assignee type values
get
List a business object's custom user fields
get
Validate a custom assignee
post
List a business object's fields
get
Get a business object's child types
get
List email templates for a business object
get
List email templates for a business object
get
List email templates for a business object
get
List email templates for a business object
get
List a business object's processes
get
Reorder an approval process list
post
Get a business object's rules
get
Count all of a business object's rules
get
Process
Create an approval process
post
Search approval processes
get
Get an approval process
get
Update an approval process
put
Delete an approval process
delete
Activate an approval process
post
Deactivate an approval process
post
Clone an approval process
post
Reorder a list of approval processes
post
Get this step's dependencies
get
List all step dependencies
get
Update an approval process step by ID
put
Delete an approval process step
delete
Reorder approval process steps
post
Get approval process steps
get
Activate an approval process step
post
Deactivate a process step
post
Check for a process
get
Count active and inactive processes
get
ProcessSteps
Create an approval process step
post
Update an approval process step
put
Get an approval process step
get
Check for a step
get
Requests
Submit for approval
post
Submit an approval asynchronously
post
Get an approval request status
get
Preview an approval
get
Approve a request
post
Approve requests
post
Reject an approval request
post
Reject approval requests
post
Reassign requests
post
Escalate an approval request
post
Reassign an approval request
post
Add an ad hoc approver
put
Delete an ad hoc approver
delete
Comment on a request ID
put
Check for objects requiring approval
post
Process escalation reminder jobs
post
Get status for a context object
get
Get status for a context object's child object
get
Recall approval requests
post
Get approval request comments
get
Bulk business object operations
post
Get an approval request
get
Get all requests for an assignee and object
get
Take ownership of a queued request
put
RuleDimensions
Save an approval rule dimension
post
Get an approval rule dimension
get
Update an approval rule dimension
put
Delete an approval rule dimension
delete
RuleEntries
Save an approval rule entry
post
Get an approval rule entry
get
Validate a rule entry label
get
Reorder rule entries
post
Rules
Save an approval rule
post
Search rules
get
Get an approval rule
get
Delete an approval rule
delete
Activate an approval rule
post
Deactivate an approval rule
post
Clone an approval rule
post
Get rule entry dependencies
get
Activate an approval rule entry
post
Deactivate an approval rule entry
post
Delete an approval rule entry
delete
Validate a rule name
get
SearchFilters
Create or update a search filter
post
Get all search filters
get
Get a search filter by ID
get
Delete a search filter by ID
delete
Activate a search filter
post
Deactivate a search filter
post
Validate a search filter name
get
SystemProperties
Get system properties
get
Update system properties
post
Get a custom configuration
get
Delete a custom configuration
delete
Create or update a custom configuration
post
Get custom configurations
get
Get Approvals product settings for all business objects
get
Get email configuration
get
Create email configuration
post
Update email configuration
patch
UserDashboard
Count user's approvals
get
Get Approval Count for BusinessObject
get
Get Dashboard count and BusinessObject data or Approval request related to the business object
post
Get user dashboard approval details
get
UserGroup
List user groups
get
Create a user group
post
Update a user group
put
Get a user group and its members by ID
get
Delete a user group by ID
delete
List user group members
get
Add a member
post
Delete a member by ID
delete
Ingress
Status
Get merge process status
get
Merge
Initiate the merge workflow
post
Download
Generate an internal URL
post
Delete an URL mapping
delete
Generate internal URLs
post
Get internal URLs' status
get
Download a file
get
Download a custom-named file
get
eSignature
ESignature
Create or update a configuration for a sign provider
put
Get sign provider configurations
get
Delete a sign provider configuration
delete
Configure the sign provider's auth code
put
Create or update a sign provider callback
put
Get a sign provider's callback configuration
get
Delete a sign provider's callback configuration
delete
Create a transaction for a sign provider
post
Send a transaction for a sign provider
post
Get transaction details
get
Get the transaction-tagging URL for a sign provider
get
Get the signing URL
get
Get transaction documents
get
Get a sign provider's transaction document
get
List supported sign providers
get
List allowed signer types
get
List supported reminder frequencies
get
Get a sign provider's transaction settings
get
Conga Sign
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.
delete
AccountEmailReminderSettings
Retrieves your current Email Reminder settings.
get
Updates your account email reminder settings.
patch
Deletes any customized Account Email Reminder settings.
delete
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.
delete
AccountPackageSettings
Retrieves a list of all your current Backoffice Package Settings
get
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 changes
patch
Deletes and resets any customized Backoffice Package settings
delete
AccountRoles
Retrieve account role information
get
Create a new account role
post
Update an account role
put
Retrieve an account role
get
Delete an account role
delete
Retrieve user IDs assigned to a role
get
Get the user's account roles
get
Create a new account role
post
AccountSigningLogos
Add, update, or delete signing ceremony logos
get
Retrieve an account's signing ceremony logos
post
AccountSigningTheme
Retrieve a customized signing theme
get
Create a customized signing theme
post
Update a customized signing theme
put
Delete customized signing themes
delete
AccountSigningUIOptions
Retrieve customized new signer experience settings
get
Patch custom signing UI options
patch
Delete customized new signer experience settings
delete
Approval
Create an approval
post
Update an approval
put
Retrieve an approval
get
Update an approval
put
Delete an existing approval
delete
Create a new field with an autogenerated name related to an existing approval
post
Retrieve an approval field
get
Update a field related to an approval
put
Delete a field from an approval.
delete
Retrieve all signable approvals
get
AuthenticationTokens
Create a sender authentication token
post
Create a multi-use signer authentication token
post
Create a new single use signer authentication token
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
CustomerOnboarded
Get Customer Onboarded
get
CustomFields
Create a custom field
post
List all custom fields. Query parameters "to" and "from" are expected to navigate pages.
get
Update a custom field
put
Delete a custom account field by ID
delete
Retrieve an account specified custom field
get
DataManagement
Retrieve the data management policy for the account
get
Update the account's data management policy
put
Retrieve the expiry configurations defined for the account
get
Update the expiry configurations defined for the account
put
Documents
Retrieve the specified document
get
Update a document
post
Update the specified document
put
Delete a document from a package
delete
Retrieve zipped documents
get
Retrieve document visibility information
get
Update document visibility
post
Retrieve an original PDF document
get
Retrieve a specific document in PDF form
get
Retrieve a page
get
Add a new document to an existing package
post
Update documents
put
Delete multiple documents from a package
delete
Create a signature confirmation
post
Sign all documents in a package
post
Apply a layout to a document
post
FileAttachment
Download all attachments
get
Download all attachments for a specific role
get
Download an attachment
get
Add an attachment
post
Delete an attachment file
delete
Download an attachment
get
Check for a specific attachment
get
Check for signer uploads
get
Check for attachments and uploads by role
get
IdvWorkflow
Retrieve the IDV authentication workflow
get
Create an IDV authentication workflow configuration
post
Update IDV workflow configuration
put
Delete IDV workflow configuration
delete
InAppReports
Retrieve reports by date and type
get
Delete the specified report files (csv)
delete
Retrieve report summaries by date and report type
get
Retrieve a report file (csv)
get
Delete a report file by ID (csv)
delete
Retrieve zipped csv reports
get
Layout
List available layouts
get
Create a new layout
post
Notification
Re-send a notification to a signer
post
Re-send a notification to a signer
post
Send an SMS notification to signers linked to a role
post
Send an SMS notification to signers linked to a role
post
Send mobile notification
post
OneSpanPackage
List packages
get
OneSpanUrl
Retrieves OneSpan BaseURL for different regions
get
Package
List packages
get
Create a package
post
Get package information
get
Update a package
put
Delete a package
delete
Get package readiness
get
Get package audit details
get
Summarize package evidence
get
List package fields
get
/v1/cs-packages/{packageId}/referencedConditions
get
Retrieve all approvals by signer
get
Get package signing status
get
Get package signature URL
get
Create packages
post
Re-create a package or template
post
Reminder
Retrieve a package's reminder schedule
get
Create a reminder schedule
post
Update a reminder schedule
put
Delete a reminder schedule
delete
Reports
Report this sender's usage
get
Report completions by sender
get
Report senders' usage for this account
get
Retrieve a usage report of transactions
get
Report transaction details for transactionId
get
Report current sender's usage
get
Role
Retrieve all package roles
get
Add new role
post
Reorder package roles
put
Retrieve a role
get
Update roles in the package
put
Delete a role
delete
Unlock a role
post
RolesVerification
Retrieve information on verification types being used
get
Update an advanced verification method
put
Create advanced verification
post
Delete an advanced verification method
delete
Retrieve advanced verification types
get
Sender
List users in an account
get
Create a user
post
Retrieve a user's detailed account information
get
Update a sender's details
post
Delete a sender
delete
Retrieve a user's signature
get
Upload a signature image
post
Delete a signature image
delete
Reset password of sender
post
Session
Retrieve session object
get
SubAccounts
List sub-accounts
get
List API keys for the current sub-account user
get
List sub-accounts
get
Create a new sub-account
post
Update a sub-account
put
VirtualRoom
Retrieve a virtual room configuration
get
Update a virtual room configuration
put
List masked fields
get
Define fields to be masked
post
Add a masked field
put
Delete a masked field
delete
List available virtual room recordings
get
Fetch a video file
get
Create a user group
post
https://rls.congacloud.com/api/approvals/v1/user-group
Creates a user group.
Language
Shell
Node
Ruby
PHP
Python
Credentials
OAuth2
Bearer
Log in to use your API keys
URL
Base URL
https://rls.congacloud.com/api/approvals
/v1/user-group
RESPONSE
Click
Try It!
to start a request and see the response here!