# Platform Documentation

> Documentation for Platform

## API Reference
- [About Conga Advantage Platform](https://developer.conga.com/platform/reference/about-conga-revenue-lifecycle-solution.md)
- [REST API Introduction](https://developer.conga.com/platform/reference/rest-api-introduction.md)
- [Authentication](https://developer.conga.com/platform/reference/authentication.md)
- [Create a user](https://developer.conga.com/platform/reference/post_api-user-management-v1-users.md): Creates a new user and returns the user's ID.
- [Get all users](https://developer.conga.com/platform/reference/get_api-user-management-v1-users.md): Returns all users that meet the criteria.
- [Create multiple users](https://developer.conga.com/platform/reference/post_api-user-management-v1-users-bulk.md): Creates multiple users and returns their IDs.<p>**Note**: <ul>If a user already exists, the user ID is returned with a validation error.</ul><ul>Bulk user creation is not supported for the `Integration` user type.</ul></p>
- [Update multiple users](https://developer.conga.com/platform/reference/patch_api-user-management-v1-users-bulk-1.md): Updates multiple users and returns the updatedUser object. <p>**Note**: Bulk user updation is not supported for the `Integration` user type.</p>
- [Update a user](https://developer.conga.com/platform/reference/patch_api-user-management-v1-users-userid-1.md): Updates the user information for a specific user.
- [Deactivate a user](https://developer.conga.com/platform/reference/delete_api-user-management-v1-users-userid.md): Deactivates a user and returns status.
- [Get user details by user ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-userid.md): Returns the details of a user based on the user ID.
- [Upload users](https://developer.conga.com/platform/reference/post_api-user-management-v1-users-upload.md): Accepts a .csv file containing user records as input, creates users, and returns the IDs for all newly created users.<p>**Note**: <ul>The system validates the uploaded file first. If the file has any incorrect field names, the validation will fail and an error message will be displayed in the response.</ul><ul>User upload is not supported for the `Integration` user type.</ul></p>
- [Clone a user](https://developer.conga.com/platform/reference/post_api-user-management-v1-users-userid-clone-1.md): Clones the user based on the user ID and returns the cloned user's ID.<p>**Note**: User clone is not supported for the `Integration` user type.</p>
- [Restore a deactivated user](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-userid-restore.md): Based on the user ID, restores the user (if deactivated) and sends the message to auth.
- [Get CSV format for user upload](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-templates-download.md): Fetches the most recent user metadata, generates a .csv file with all of the user fields, and returns a template for uploading users for download.
- [Get a user's role](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-userid-roles.md): Retrieves a user's role based on the user ID and returns the status as the role name.
- [Check if a user is assigned a role](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-userid-roles-roleid-exists.md): Using a user ID and a role ID, returns true or false depending on whether the user is assigned a role or not.
- [Update a user's role](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-userid-roles-roleid.md): Updates a user's role based on the user ID and role ID passed in.
- [Assign permission group to a user](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-userid-permissiongroups.md): Appends the permission group name to the provided user's current permission groups and returns the updatedUser object.
- [Delete permission groups from a user](https://developer.conga.com/platform/reference/delete_api-user-management-v1-users-userid-permissiongroups-1.md): Removes the permission group names from the provided user's current permission groups and returns the updatedUser object along with error messages for invalid records.
- [Create and update multiple users](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-bulk-upsert-1.md): Creates and updates multiple users and returns the IDs of the users. <p>**Note**: If a user already exists (based on a Platform user record identifier), the API will update the existing user instead of creating a duplicate record , else if the user is not present new record is created.</p>
- [Re-send welcome email to new user](https://developer.conga.com/platform/reference/post_api-user-management-v1-users-userid-send-welcome-email-1.md): The system sends every new user a welcome email with login details. If a user is created with an incorrect email address entry, the welcome email cannot reach its intended recipient. In such instances, use this API service to re-send the welcome email and credentials. <p>**Note**: Re-send welcome email is not supported for the `Integration` user type.</p>
- [Get integration user's client ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-users-integrationuserid-secret-1.md): Retrieves integration user's client ID based on the user ID.
- [Generate integration user secret](https://developer.conga.com/platform/reference/patch_api-user-management-v1-users-integrationuserid-secret-1.md): Generates the **Secret** for the provided integration user ID and returns the Client ID and Client Secret.
- [Create and update multiple users synchronously](https://developer.conga.com/platform/reference/put_api-user-management-v1-users-bulk-upsert-sync.md): Creates and updates multiple users and returns the IDs of the users synchronously. <p>**Note**: If a user already exists (based on a Platform user record identifier), the API will update the existing user instead of creating a duplicate record , else if the user is not present new record is created.</p>
- [Create a user group](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-groups-1.md): Creates a new user group and returns the user group's ID.
- [Get filtered user groups](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-1.md): Returns all user groups that meet the criteria.
- [Update a user group](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-groups-usergroupid-1.md): Updates the user group information for a specific group.
- [Delete a user group](https://developer.conga.com/platform/reference/delete_api-user-management-v1-user-groups-usergroupid-1.md): Deletes a user group and returns status.
- [Get user group details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-usergroupid-1.md): Returns the details of a user group based on the user group ID.
- [Create and update multiple user groups](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-groups-bulk-upsert-usergroups-1.md): Creates and updates multiple user groups and returns the ids of the user groups created and updated. <p>**Note**: If a user group already exists (based on a Platform user record identifier), the API will update the existing user group instead of creating a duplicate record , else if the user group is not present new record is created.</p>
- [Create a user group member](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-groups-usergroupid-members-memberid-1.md): Adds a new member to the group and returns the ID of the newly added member.
- [Delete a user group member](https://developer.conga.com/platform/reference/delete_api-user-management-v1-user-groups-usergroupid-members-memberid-1.md): Deletes a user group member and returns status.
- [Create user group members in bulk](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-groups-bulk-create-usergroupmembers-1.md): Adds new members to user groups and returns the IDs of the newly added members.
- [Get all user group members by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-usergroupid-members-1.md): Returns all user group members that meet the criteria.
- [Get user group member details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-members-usergroupmemberid-1.md): Returns the details of a user group member based on the user group member ID.
- [Get all user group members](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-groups-members-1.md): Returns all user group members that meet the criteria.
- [Create a new role](https://developer.conga.com/platform/reference/post_api-user-management-v1-roles.md): Creates a new role and returns the role's ID.
- [Get all roles](https://developer.conga.com/platform/reference/get_api-user-management-v1-roles.md): Returns all roles that meet the criteria.
- [Create multiple roles](https://developer.conga.com/platform/reference/post_api-user-management-v1-roles-bulk.md): Creates multiple roles and returns their IDs.
- [Update a role](https://developer.conga.com/platform/reference/put_api-user-management-v1-roles-roleid.md): Updates the name and description of the provided role ID.
- [Delete a role](https://developer.conga.com/platform/reference/delete_api-user-management-v1-roles-roleid.md): Deletes the role with the given role ID and returns the status.
- [Get role information by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-roles-roleid.md): Returns the details of a role based on the role ID.
- [Check whether the role exists](https://developer.conga.com/platform/reference/get_api-user-management-v1-roles-roleid-exists.md): Uses the role ID as an input to check whether the role exists.
- [Assign permission groups to a role](https://developer.conga.com/platform/reference/put_api-user-management-v1-roles-roleid-permissiongroups.md): Appends the permission group names to the provided role's current permission groups and returns the updated role.
- [Delete permission groups from a role](https://developer.conga.com/platform/reference/delete_api-user-management-v1-roles-roleid-permissiongroups-1.md): Removes the permission group names from the provided role's current permission groups and returns the updated role along with error messages for invalid records.
- [Clone a role](https://developer.conga.com/platform/reference/post_api-user-management-v1-roles-roleid-clone.md): Clones the role based on the role ID and returns the cloned role's ID.
- [Assign admin permissions to a role](https://developer.conga.com/platform/reference/put_api-user-management-v1-roles-roleid-admin-permissions-1.md): Appends the admin permission to the provided role's current admin permissions and returns the updated role.
- [Delete admin permissions from a role](https://developer.conga.com/platform/reference/delete_api-user-management-v1-roles-roleid-admin-permissions-1.md): Removes the admin permissions from the provided role's current admin permissions and returns the updated role.
- [Get the master list of admin permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-admin-permissions-1.md): Returns the master list of admin permissions from the data storage.
- [Get the master list of permission groups](https://developer.conga.com/platform/reference/get_api-user-management-v1-permissiongroups.md): Returns the master list of permission groups from data storage.
- [Add permission group names to the master list](https://developer.conga.com/platform/reference/post_api-user-management-v1-permissiongroups.md): Adds permission group names to the master list and returns the updated list of permission groups.
- [Delete permission groups](https://developer.conga.com/platform/reference/delete_api-user-management-v1-permissiongroups.md): Removes permission group names from the stored master list, as well as any associated object, action, or scope permissions granted to that permission group if no user or role is associated with it, and returns a list of the deleted permission group's IDs and error messages for invalid records.
- [Clone the permission group](https://developer.conga.com/platform/reference/post_api-user-management-v1-permissiongroups-permissiongroupname-clone-1.md): Clones the permission group (Object Permissions and Scopes Permissions) by passing the existing permission group as a parameter and the permission group information in the request body.
- [Update organizational information](https://developer.conga.com/platform/reference/patch_api-user-management-v1-organization-info.md): Updates an organization's sitewide information, like number, date, and currency formats.
- [Get an organization's information](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-info.md): Returns an organization's sitewide information, like number, date, and currency formats.
- [Get the locale](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-locale.md): Returns the organization's locale.
- [Get the time zone](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-timezone.md): Returns the organization's time zone.
- [Get the currency type](https://developer.conga.com/platform/reference/get_api-user-management-v1-organization-currency.md): Returns the organization's currency.
- [Add external identifiers](https://developer.conga.com/platform/reference/post_api-user-management-v1-integrations-externalintegrationid-1.md): Add an organization's external integration identifiers.
- [Remove external identifiers](https://developer.conga.com/platform/reference/delete_api-user-management-v1-integrations-externalintegrationid.md): Updates an organization's external integration and removes external identifiers.
- [Get external identifiers](https://developer.conga.com/platform/reference/get_api-user-management-v1-integrations-externalintegrationid.md): Returns the external identifiers of an external integration.
- [Update external identifiers](https://developer.conga.com/platform/reference/put_api-user-management-v1-integrations-externalintegrationid.md): Updates an organization's external integration identifiers.
- [Get all identity providers (IdPs)](https://developer.conga.com/platform/reference/get_api-user-management-v1-integrations-identity-providers-1.md): Retrieves all identity providers.
- [Add an external identifier](https://developer.conga.com/platform/reference/post_api-user-management-v1-integrations-1.md): Add an organization's external integration identifier.
- [Update external identifiers](https://developer.conga.com/platform/reference/put_api-user-management-v1-integrations-1.md): Updates an organization's external integration identifiers.
- [Delete external identifiers](https://developer.conga.com/platform/reference/delete_api-user-management-v1-integrations-1.md): Deletes external identifiers.
- [Get a list of external integration identifiers](https://developer.conga.com/platform/reference/get_api-user-management-v1-integrations-1.md): Returns all external integration identifiers that meet the specified criteria, with support for sorting and pagination.
- [Update an external integration identifier](https://developer.conga.com/platform/reference/patch_api-user-management-v1-integrations-id-1.md): Updates an organization's external integration identifier.
- [Add API connection](https://developer.conga.com/platform/reference/post_api-user-management-v1-api-connections-externalidentifier-1.md): Adds API connection.
- [Update API connection](https://developer.conga.com/platform/reference/put_api-user-management-v1-api-connections-externalidentifier-1.md): Updates API connection.
- [Get API connections](https://developer.conga.com/platform/reference/get_api-user-management-v1-api-connections-externalidentifier.md): Retrieves API connections based on the API connection type selected.
- [Get all API connections](https://developer.conga.com/platform/reference/get_api-user-management-v1-api-connections.md): Retrieves all API connections.
- [Update API connection status](https://developer.conga.com/platform/reference/put_api-user-management-v1-api-connections-externalidentifier-status.md): Updates the status of the API connection.
- [Create a guest user](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-guest-1.md): Creates a guest user and returns the guest user's ID.
- [Update a guest user](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-guest-userid-1.md): Updates the user information for a specific guest user.
- [Deactivate a guest user](https://developer.conga.com/platform/reference/delete_api-user-management-v1-user-guest-userid-1.md): Deactivates a guest user and returns the status.
- [Restore a deactivated guest user](https://developer.conga.com/platform/reference/put_api-user-management-v1-user-guest-userid-restore-1.md): Based on the guest user ID, restores a guest user (if deactivated) and sends the message to auth.
- [Register storefront](https://developer.conga.com/platform/reference/patch_api-user-management-v1-user-guest-storefront-1.md): Updates the mapping between a guest user and a storefront, including storefront type and URL.
- [Create a contact user.](https://developer.conga.com/platform/reference/post_api-user-management-v1-contact-users.md)
- [Update a contact user.](https://developer.conga.com/platform/reference/put_api-user-management-v1-contact-users-userid.md)
- [Deactivate a contact user.](https://developer.conga.com/platform/reference/delete_api-user-management-v1-contact-users-userid.md)
- [Reactivate a previously deactivated contact user.](https://developer.conga.com/platform/reference/put_api-user-management-v1-contact-users-userid-restore.md)
- [Set field permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-field-permissions-1.md): Sets field permissions and returns a unique identifier (ID).
- [Get the field permission details by object and permission group name](https://developer.conga.com/platform/reference/get_api-user-management-v1-field-permissions-1.md): Fetches the field permission details for the given object and permission group name.
- [Update a field permission for a given permission group and object](https://developer.conga.com/platform/reference/put_api-user-management-v1-field-permissions-1.md): Updates a field permission for a given permission group and object, and returns the updated field permission details.
- [Delete a field permission by permission group and object](https://developer.conga.com/platform/reference/delete_api-user-management-v1-field-permissions-1.md): Deletes a field permission from the given permission group and object.
- [Set multiple field permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-field-permissions-bulk-1.md): Sets multiple field permissions and returns their respective unique identifiers (ID).
- [Get the field permission details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-field-permissions-fieldpermissionid-1.md): Fetches the field permission details based on the field permission ID.
- [Update a field permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-field-permissions-fieldpermissionid-1.md): Updates a field permission and returns the updated field permission details.
- [Delete a field permission by ID](https://developer.conga.com/platform/reference/delete_api-user-management-v1-field-permissions-fieldpermissionid-1.md): Deletes a field permission for the given field permission ID.
- [Create a new object permission](https://developer.conga.com/platform/reference/post_api-user-management-v1-objectpermissions.md): Creates a new object permission and returns the object permission's ID.
- [Get all object permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions.md): Returns all object permissions that meet the criteria.
- [Create multiple object permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-objectpermissions-bulk.md): Creates multiple object permissions and returns their IDs.
- [Delete multiple object permission records](https://developer.conga.com/platform/reference/delete_api-user-management-v1-objectpermissions-bulk.md): Removes multiple object permission records and returns a list of the deleted object permission's IDs as well as error messages for invalid records.
- [Get object permission details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objectpermissionid.md): Fetches the object permission details based on the object permission ID.
- [Update an object permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-objectpermissions-objectpermissionid.md): Updates an object permission and returns updated object permission details.
- [Delete an object permission](https://developer.conga.com/platform/reference/delete_api-user-management-v1-objectpermissions-objectpermissionid.md): Removes an object permission and returns the deleted object permission's ID.
- [Validate object action permission](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objectname-actionpermissions-actionname-validate.md): Based on the object name and action name, validates whether the object has action permission.
- [Get object permission details by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objects-objectname.md): Fetches the object permission details for the provided object name.
- [List all object names for object permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-objectpermissions-objects-1.md): Fetches and lists all objects for object permissions and returns `OK` when the request is executed.
- [Upsert a new property permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-property-permissions-permissiongroupname-propertyname-1.md): Upserts a new property permission
- [Get property permissions By permissionGroupName and propertyName](https://developer.conga.com/platform/reference/get_api-user-management-v1-property-permissions-permissiongroupname-propertyname-1.md): Retrieves property permissions based on permissionGroupName and propertyName.
- [Delete a Property Permission](https://developer.conga.com/platform/reference/delete_api-user-management-v1-property-permissions-permissiongroupname-propertyname-1.md): Removes Property Permission for given permissionGroupName and propertyName
- [Get property objects for a given permissionGroupName](https://developer.conga.com/platform/reference/get_api-user-management-v1-property-permissions-permissiongroupname-propertyobjects-1.md): Retrieves property objects based on the PermissionGroupName.
- [Set a record type's permission](https://developer.conga.com/platform/reference/post_api-user-management-v1-recordtype-permissions-1.md): Sets a record type's permission and returns its unique identifier (ID).
- [Update a record type's permission for a given permission group and object](https://developer.conga.com/platform/reference/put_api-user-management-v1-recordtype-permissions-1.md): Updates a record type's permission for a given permission group and object, and returns the updated record type permission details.
- [Set multiple record type permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-recordtype-permissions-bulk-1.md): Sets multiple record type permissions and returns their unique identifiers (ID).
- [Get the record type permission details by object and permission group name](https://developer.conga.com/platform/reference/get_api-user-management-v1-recordtype-permissions-permissiongroupname-objectname-1.md): Fetches the record type permission details based on the object and permission group name.
- [Delete a record type's permission by permission group and object](https://developer.conga.com/platform/reference/delete_api-user-management-v1-recordtype-permissions-permissiongroupname-objectname-1.md): Removes a record type's permission from the given permission group and object.
- [Get the record type permission details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-recordtype-permissions-recordtypepermissionid-1.md): Fetches the record type permission details based on the record type permission ID.
- [Update a record type's permission](https://developer.conga.com/platform/reference/put_api-user-management-v1-recordtype-permissions-recordtypepermissionid-1.md): Updates a record type's permission and returns the updated record type permission details.
- [Delete a record type's permission by ID](https://developer.conga.com/platform/reference/delete_api-user-management-v1-recordtype-permissions-recordtypepermissionid-1.md): Removes a record type's permission for the given record type permission ID.
- [Get the master list of all action permissions](https://developer.conga.com/platform/reference/get_api-user-management-v1-actionpermissions.md): Retrieves the master list of action permissions from the data storage.
- [Get logged-in user information](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-info.md): Returns information about the current logged-in user.<p>**Note**: If the locale, currency, and time zone information are not available at the user level, this endpoint retrieves them from the organization level.</p>
- [Get logged-in user's locale](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-locale.md): Returns the locale information for the current logged-in user.
- [Get logged-in user's time zone](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-timezone.md): Returns time zone information for the current logged-in user.
- [Get logged-in user's currency](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-currency.md): Returns currency information for the current logged-in user.
- [Get logged-in user's currency format](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-currency-format-1.md): Returns currency format information for the current logged-in user.
- [Get all action permissions for the current user](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-actionpermissions.md): Returns a list of all object action permissions available for the current user.
- [Get action permissions by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-actionpermissions-1.md): Retrieves the details of action permissions on the object name.
- [Get bulk action permissions](https://developer.conga.com/platform/reference/post_api-user-management-v1-user-objects-actionpermissions-1.md): Retrieves the details of action permissions on the object names.
- [Get record type permission details by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-recordtypes-1.md): Fetches the record type permission details based on the object name.
- [Get field permission details by object name](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-field-permissions-1.md): Fetches the field permission details based on the object name.
- [Get field permission details by field name on given object](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-field-permissions-fields-fieldname-1.md): Fetches the field permission details based on the field name on given object.
- [Get users with full access on given objects](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-object-access-users-1.md): Fetches users who have full access on all objects passed as input.
- [Get accessible property values of property object by object name and action type](https://developer.conga.com/platform/reference/get_api-user-management-v1-user-objects-objectname-property-permissions-propertyname-actionname.md): Returns a list of property values that the current user can access for the specified property on the given object with the specified action type.
- [Update a user's UI settings](https://developer.conga.com/platform/reference/patch_api-user-management-v1-user-userid-ui-settings.md): Updates a user's UI settings based on the user ID and the provided settings.
- [Get all roles](https://developer.conga.com/platform/reference/get_api-user-management-v1-runtime-roles-1.md): Returns all roles that meet the criteria.
- [Get all time zones](https://developer.conga.com/platform/reference/get_api-user-management-v1-timezones.md): Retrieves all time zones.
- [Get all locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-locales.md): Retrieves all locales.
- [Get all decimal symbols from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-decimal-symbols-1.md): Retrieves all decimal symbols from locales.
- [Get all digit grouping symbols from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-digitgrouping-symbols-1.md): Retrieves all digit grouping symbols from locales.
- [Get all long date formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-longdate-formats-1.md): Retrieves all long date formats from locales.
- [Get all short date formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-shortdate-formats-1.md): Retrieves all short date formats from locales.
- [Get all time formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-time-formats-1.md): Retrieves all time formats from locales.
- [Get all digit groups from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-digitgroups-1.md): Retrieves all digit groups from locales.
- [Get all negative number formats from locales](https://developer.conga.com/platform/reference/get_api-user-management-v1-negativenumber-formats-1.md): Retrieves all negative number formats from locales.
- [Get all currency formats](https://developer.conga.com/platform/reference/get_api-user-management-v1-currency-formats-1.md): Retrieves all currency formats based on the provided format type.
- [Create a Grant Login Request](https://developer.conga.com/platform/reference/post_api-user-management-v1-grantlogin-1.md): Creates a Grant Login Request and returns its unique identifier (ID).
- [Get all Grant Login Requests](https://developer.conga.com/platform/reference/get_api-user-management-v1-grantlogin-1.md): Returns all grant logins that meet the criteria.
- [Cancel Grant Login Request](https://developer.conga.com/platform/reference/put_api-user-management-v1-grantlogin-grantloginid-1.md): Cancels the Grant Login Request and returns status.
- [Get the grant login details by ID](https://developer.conga.com/platform/reference/get_api-user-management-v1-grantlogin-grantloginid-1.md): Fetches the grant login details based on the grant login ID.
- [Get Access durations](https://developer.conga.com/platform/reference/get_api-user-management-v1-grantlogin-durations-1.md): Retrieves all Access Durations available.
- [Define a new object schema](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-1.md): Validates and creates an object schema definition.
- [List all object names](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-1.md): Fetches and lists all metadata and returns `OK` when the request is executed.
- [Update a schema definition](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-1.md): Validates and updates an object's schema definition.
- [Get a translated schema definition](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-objectname-1.md): Validates and fetches a given object's schema definition.
- [Set an object's shared status](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-shared-isshared-1.md): Sets the IsShared field for the given object to indicate whether the object is shareable.
- [Deprecate an object](https://developer.conga.com/platform/reference/patch_api-schema-v1-objects-objectname-deprecate-1.md): Deprecates the object in the metadata, accepting the object name as input and setting it to be deprecated.
- [Import custom schema](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-customschema-import-1.md): Imports schema for custom fields and custom objects. 
             <ul><li><b>For standard object</b>: Creates missing custom fields from the corresponding JSON file (part of the ZIP file).</li><li><b>For custom object</b>: If a custom object is not available, it is created with all the fields; otherwise, it creates missing custom fields from the corresponding JSON file (part of the ZIP file).</li></ul>
- [Validate lookup criteria](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-lookupobjectname-lookup-criteria-validate-1.md): Validates the provided lookup criteria against the schema of the specified lookup object.
- [Create a field definition for an object](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-fields-1.md): Validates and creates a field inside the specified object.
- [Delete a custom field definition](https://developer.conga.com/platform/reference/delete_api-schema-v1-objects-objectname-fields-fieldname-1.md): Validates and deletes a custom field from the specified object.<p>**Note:** The custom field is deleted only if it contains no data in any of the records.</p>
- [Update an object's field definition](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-fields-fieldname-1.md): Validates and updates the field definitions available in the specified object.
- [Set the field to deprecate](https://developer.conga.com/platform/reference/patch_api-schema-v1-objects-objectname-fields-fieldname-deprecate-1.md): Validates the field of the given object and sets it to be deprecated.
- [Validate formula field expression](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-fields-fieldname-expression-validate-1.md): Validates the formula field expression of the field of the given object.
- [Get the list of formula functions](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-formula-functions-1.md): Retrieves the list of formula functions from data storage.
- [Index a field](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-indexes-1.md): Validates and enables the "IsIndexField" field value to true for a field in a given object.
- [Delete an existing index](https://developer.conga.com/platform/reference/delete_api-schema-v1-objects-objectname-indexes-indexfieldname-1.md): Validates and sets the "IsIndexField" field value to false for a field in a given object.
- [Create a new picklist](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-picklists-1.md): Validates and creates a new picklist metadata for the given object.
- [Rename a picklist](https://developer.conga.com/platform/reference/patch_api-schema-v1-objects-objectname-picklists-rename-1.md): Validates and renames the picklist for the given object and picklist and returns 'OK' when the request is executed.
- [Update a picklist](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-picklists-picklistname-1.md): Validates and updates the picklist for the given object and picklist and returns 'OK' when the request is executed.
- [Create a new picklist entry](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-1.md): Validates and creates a picklist entry for the given picklist and object.
- [Update a picklist entry by value](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-picklistentryvalue-1.md): Validates and updates the picklist value details for the given picklist and object.
- [Create picklist entries by value](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-bulk-1.md): Validates and updates the picklist value details for the given picklist and object.
- [Update picklist entries by value](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-picklists-picklistname-picklist-entries-bulk-1.md): Validates and updates the picklist value details for the given picklist and object.
- [Get the dependent picklist](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and fetches the dependent picklist metadata for the given dependent field name and object.
- [Create a new dependent picklist mapping](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and creates a new dependent picklist mapping for the given dependent field name and object.
- [Update the dependent picklist](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and updates the dependent picklist metadata for the given dependent field name and object.
- [Delete the dependent picklist](https://developer.conga.com/platform/reference/delete_api-schema-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and removes the dependent picklist metadata for the given dependent field and object.
- [Create a record type picklist entry](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-recordtype-entries-1.md): Validates and creates a picklist entry (value detail) for a given object's record type.
- [Update record type picklist entries](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-recordtype-entries-bulk-1.md): Validates and updates the picklist entries (value details) for a given object's record type.
- [Create new complex field metadata](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-complex-fields-1.md): Validates and creates metadata for complex fields.
- [Create a new complex field](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-complex-field-complexfieldmetadataname-1.md): Validates and creates a complex field for the given complex field metadata.
- [Update an object's complex field definition](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-complex-field-complexfieldmetadataname-1.md): Validates and updates the complex field definition for the given complex field metadata and object.
- [Create complex fields](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-complex-fields-complexfieldmetadataname-1.md): Validates and creates multiple complex fields for the given complex field metadata.
- [Define the translation](https://developer.conga.com/platform/reference/post_api-schema-v1-objects-objectname-translations-locale-1.md): Defines the translation for the given object and language-region combination.
- [Update translation](https://developer.conga.com/platform/reference/put_api-schema-v1-objects-objectname-translations-locale-1.md): Updates translation for the given object.
- [Get translation](https://developer.conga.com/platform/reference/get_api-schema-v1-objects-objectname-translations-locale-1.md): Retrieves a translation for the given object.
- [Delete translation](https://developer.conga.com/platform/reference/delete_api-schema-v1-objects-objectname-translations-locale-1.md): Deletes the translation for the given object and locale.
- [Get a schema definition](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-objectname-1.md): Validates and retrieves an object's metadata at runtime.
- [Export custom schema](https://developer.conga.com/platform/reference/post_api-metadata-v1-objects-customschema-export-1.md): For the object(s) passed in the request body, exports a schema (zipped, with a JSON file for each object) for custom fields and custom objects. This exports:
             <ul><li>All of a custom object, except its default field.</li><li>All of a standard object, except its default and standard fields.</li></ul>
- [Get all dependencies](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-objectname-dependencies-1.md): Retrieves all dependencies for a given object.
- [Get all references](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-objectname-references-1.md): Retrieves all references to the given object.
- [Get field metadata](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-objectname-fields-fieldname-1.md): Retrieves the metadata of the specified field.
- [Get field dependencies](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-objectname-fields-fieldname-dependency-fields-1.md): Retrieves the metadata of a specified field, including information about any dependent fields.
- [Get the dependent picklist definition](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-objectname-fields-fieldname-dependent-picklists-1.md): Validates and fetches the dependent picklist metadata for the given dependent field name and object.
- [Get all scoped object names](https://developer.conga.com/platform/reference/get_api-metadata-v1-objects-1.md): Retrieves a list of object information, including object names and basic metadata, with support for sorting, pagination, and optional filtering.
- [Insert a new custom object record](https://developer.conga.com/platform/reference/post_api-data-v1-custom-objects-objectname-1.md): Validates the record details and inserts if it does not exist in the given custom object.
- [Get all custom object records](https://developer.conga.com/platform/reference/get_api-data-v1-custom-objects-objectname-1.md): Returns a list of all records for the given custom object.
- [Get a custom object record using record ID](https://developer.conga.com/platform/reference/get_api-data-v1-custom-objects-objectname-id-1.md): Checks the record ID in the given custom object and fetches the record if it exists.
- [Update a custom object record](https://developer.conga.com/platform/reference/put_api-data-v1-custom-objects-objectname-id-1.md): Updates the record based on the custom object, record ID, and the details of the record to update.
- [Delete a custom object record](https://developer.conga.com/platform/reference/delete_api-data-v1-custom-objects-objectname-id-1.md): Validates the record based on the record ID and removes it from the given custom object.
- [Get a custom object record using externalId](https://developer.conga.com/platform/reference/get_api-data-v1-custom-objects-objectname-by-externalid-externalid-1.md): Checks the externalId in the given custom object and fetches the record if it exists.
- [Update a record by externalId](https://developer.conga.com/platform/reference/put_api-data-v1-custom-objects-objectname-by-externalid-externalid-1.md): Updates the record based on the object, externalId, and the details of the record that you want to update.
- [Delete a custom object record by externalId](https://developer.conga.com/platform/reference/delete_api-data-v1-custom-objects-objectname-by-externalid-externalid-1.md): Validates the record based on the external ID and removes it from the given custom object.
- [Insert custom object records](https://developer.conga.com/platform/reference/post_api-data-v1-custom-objects-objectname-bulk-1.md): Validates custom object record details and creates multiple records in the given custom object.
- [Update custom object records](https://developer.conga.com/platform/reference/put_api-data-v1-custom-objects-objectname-bulk-1.md): Validates the custom object record details and updates multiple records in the given custom object.
- [Delete custom object records](https://developer.conga.com/platform/reference/delete_api-data-v1-custom-objects-objectname-bulk-1.md): Removes multiple records from the given custom object.
- [Upsert custom object records](https://developer.conga.com/platform/reference/patch_api-data-v1-custom-objects-objectname-bulk-1.md): Validates the record details and updates if the ID already exists in the provided object, else inserts if it does not.
- [Update custom object records as per the criteria](https://developer.conga.com/platform/reference/put_api-data-v1-custom-objects-objectname-criteria-bulk-1.md): Validates the custom object record details and updates multiple records that satisfy the given criteria.
- [Delete custom object records as per the criteria](https://developer.conga.com/platform/reference/delete_api-data-v1-custom-objects-objectname-criteria-bulk-1.md): Removes multiple records that satisfy the criteria in the custom object.
- [Get object record count and size on disk](https://developer.conga.com/platform/reference/get_api-data-v1-custom-objects-objectname-summary-1.md): Returns a count of all records for the given object, and it's size on disk.
- [Execute multiple queries](https://developer.conga.com/platform/reference/post_api-data-v1-custom-objects-query-parallel-1.md): Executes multiple query requests parallelly on custom objects and returns the responses of each query in a list.
- [Execute single query](https://developer.conga.com/platform/reference/post_api-data-v1-custom-objects-query-objectname-1.md): Validates and executes the query request for the given custom object and specifying whether the total record count should be included in the response.
- [Get all record types for the custom object](https://developer.conga.com/platform/reference/get_api-data-v1-custom-objects-objectname-recordtypes-1.md): Retrieves a list of all record types for the given custom object.
- [Get all currency](https://developer.conga.com/platform/reference/get_api-data-v1-currencies-1.md): Retrieves all currencies.
- [Share a record](https://developer.conga.com/platform/reference/post_api-data-v1-objects-objectname-recordid-share-1.md): This bulk request API shares a record with users and user groups based on the provided object name and record ID and sends an email notification to the user or user group.
- [Update a shared record's access level](https://developer.conga.com/platform/reference/put_api-data-v1-objects-objectname-recordid-access-level-1.md): Updates the access level, such as View or Edit, for a shared record based on the provided object name and record ID.
- [Un-share a record](https://developer.conga.com/platform/reference/delete_api-data-v1-objects-objectname-recordid-un-share-1.md): Removes access to a record for a user or user group based on the given object name and record ID.
- [Get a record's sharing information](https://developer.conga.com/platform/reference/get_api-data-v1-objects-objectname-recordid-sharing-info-1.md): Gets sharing information about a record, including which users or user groups have access to it and their corresponding permission levels, based on the object name and record ID.
- [Get a record's sharing status](https://developer.conga.com/platform/reference/get_api-data-v1-objects-objectname-recordid-trackingid-sharing-status-1.md): Gets the status of a record shared with a user group, such as `STARTED`, `IN PROGRESS`, or `SUCCESS`, based on the object name, record ID, and tracking ID.
- [Get a user's access details for a shared record](https://developer.conga.com/platform/reference/get_api-data-v1-objects-objectname-recordid-userid-access-level-1.md): Retrieves the access details for a specific user on a given record, including permission levels such as View, Edit, or Delete.
- [Insert a new account record](https://developer.conga.com/platform/reference/post_api-data-v1-account-1.md): Validates the record details and inserts if it does not exist in the given object.
- [Get all account records](https://developer.conga.com/platform/reference/get_api-data-v1-account-1.md): Returns a list of all records for the given object.
- [Get a account record using account record ID](https://developer.conga.com/platform/reference/get_api-data-v1-account-id-1.md): Checks the record ID in the given object and fetches the record if it exists.
- [Update a account record](https://developer.conga.com/platform/reference/put_api-data-v1-account-id-1.md): Updates the record based on the object, record ID, and the details of the record that you want to update.
- [Delete a account record](https://developer.conga.com/platform/reference/delete_api-data-v1-account-id-1.md): Validates the record based on the record ID and removes it from the given object.
- [Get a account record using externalId](https://developer.conga.com/platform/reference/get_api-data-v1-account-by-externalid-externalid-1.md): Checks the externalId in the given object and fetches the record if it exists.
- [Update a account record by externalId](https://developer.conga.com/platform/reference/put_api-data-v1-account-by-externalid-externalid-1.md): Updates the record based on the object, externalId, and the details of the record that you want to update.
- [Delete a account record by externalId](https://developer.conga.com/platform/reference/delete_api-data-v1-account-by-externalid-externalid-1.md): Validates the record based on the External ID and removes it from the given object.
- [Insert multiple account records](https://developer.conga.com/platform/reference/post_api-data-v1-account-bulk-1.md): Validates the object record details and creates multiple records in the given object.
- [Update multiple account records](https://developer.conga.com/platform/reference/put_api-data-v1-account-bulk-1.md): Validates the object record details and updates multiple records in the given object.
- [Delete multiple account records](https://developer.conga.com/platform/reference/delete_api-data-v1-account-bulk-1.md): Removes multiple records from the given object.
- [Upsert multiple account records](https://developer.conga.com/platform/reference/patch_api-data-v1-account-bulk-1.md): Validates the record details and updates if the ID already exists in the provided object, else inserts if it does not.
- [Get object account record count and size on disk](https://developer.conga.com/platform/reference/get_api-data-v1-account-summary-1.md): Returns a count of all records for the given object, and it's size on disk.
- [Execute single query](https://developer.conga.com/platform/reference/post_api-data-v1-account-query-1.md): Validates and executes the query request for the given object and specifying whether the total record count should be included in the response.
- [Get all account record types](https://developer.conga.com/platform/reference/get_api-data-v1-account-recordtypes-1.md): Retrieves a list of all record types for the given object.
- [Insert a new contact record](https://developer.conga.com/platform/reference/post_api-data-v1-contact-1.md): Validates the record details and inserts if it does not exist in the given object.
- [Get all contact records](https://developer.conga.com/platform/reference/get_api-data-v1-contact-1.md): Returns a list of all records for the given object.
- [Get a contact record using contact record ID](https://developer.conga.com/platform/reference/get_api-data-v1-contact-id-1.md): Checks the record ID in the given object and fetches the record if it exists.
- [Update a contact record](https://developer.conga.com/platform/reference/put_api-data-v1-contact-id-1.md): Updates the record based on the object, record ID, and the details of the record that you want to update.
- [Delete a contact record](https://developer.conga.com/platform/reference/delete_api-data-v1-contact-id-1.md): Validates the record based on the record ID and removes it from the given object.
- [Get a contact record using externalId](https://developer.conga.com/platform/reference/get_api-data-v1-contact-by-externalid-externalid-1.md): Checks the externalId in the given object and fetches the record if it exists.
- [Update a contact record by externalId](https://developer.conga.com/platform/reference/put_api-data-v1-contact-by-externalid-externalid-1.md): Updates the record based on the object, externalId, and the details of the record that you want to update.
- [Delete a contact record by externalId](https://developer.conga.com/platform/reference/delete_api-data-v1-contact-by-externalid-externalid-1.md): Validates the record based on the External ID and removes it from the given object.
- [Insert multiple contact records](https://developer.conga.com/platform/reference/post_api-data-v1-contact-bulk-1.md): Validates the object record details and creates multiple records in the given object.
- [Update multiple contact records](https://developer.conga.com/platform/reference/put_api-data-v1-contact-bulk-1.md): Validates the object record details and updates multiple records in the given object.
- [Delete multiple contact records](https://developer.conga.com/platform/reference/delete_api-data-v1-contact-bulk-1.md): Removes multiple records from the given object.
- [Upsert multiple contact records](https://developer.conga.com/platform/reference/patch_api-data-v1-contact-bulk-1.md): Validates the record details and updates if the ID already exists in the provided object, else inserts if it does not.
- [Get object contact record count and size on disk](https://developer.conga.com/platform/reference/get_api-data-v1-contact-summary-1.md): Returns a count of all records for the given object, and it's size on disk.
- [Execute single query](https://developer.conga.com/platform/reference/post_api-data-v1-contact-query-1.md): Validates and executes the query request for the given object and specifying whether the total record count should be included in the response.
- [Get all contact record types](https://developer.conga.com/platform/reference/get_api-data-v1-contact-recordtypes-1.md): Retrieves a list of all record types for the given object.
- [Insert a new opportunity record](https://developer.conga.com/platform/reference/post_api-data-v1-opportunity-1.md): Validates the record details and inserts if it does not exist in the given object.
- [Get all opportunity records](https://developer.conga.com/platform/reference/get_api-data-v1-opportunity-1.md): Returns a list of all records for the given object.
- [Get a opportunity record using opportunity record ID](https://developer.conga.com/platform/reference/get_api-data-v1-opportunity-id-1.md): Checks the record ID in the given object and fetches the record if it exists.
- [Update a opportunity record](https://developer.conga.com/platform/reference/put_api-data-v1-opportunity-id-1.md): Updates the record based on the object, record ID, and the details of the record that you want to update.
- [Delete a opportunity record](https://developer.conga.com/platform/reference/delete_api-data-v1-opportunity-id-1.md): Validates the record based on the record ID and removes it from the given object.
- [Get a opportunity record using externalId](https://developer.conga.com/platform/reference/get_api-data-v1-opportunity-by-externalid-externalid-1.md): Checks the externalId in the given object and fetches the record if it exists.
- [Update a opportunity record by externalId](https://developer.conga.com/platform/reference/put_api-data-v1-opportunity-by-externalid-externalid-1.md): Updates the record based on the object, externalId, and the details of the record that you want to update.
- [Delete a opportunity record by externalId](https://developer.conga.com/platform/reference/delete_api-data-v1-opportunity-by-externalid-externalid-1.md): Validates the record based on the External ID and removes it from the given object.
- [Insert multiple opportunity records](https://developer.conga.com/platform/reference/post_api-data-v1-opportunity-bulk-1.md): Validates the object record details and creates multiple records in the given object.
- [Update multiple opportunity records](https://developer.conga.com/platform/reference/put_api-data-v1-opportunity-bulk-1.md): Validates the object record details and updates multiple records in the given object.
- [Delete multiple opportunity records](https://developer.conga.com/platform/reference/delete_api-data-v1-opportunity-bulk-1.md): Removes multiple records from the given object.
- [Upsert multiple opportunity records](https://developer.conga.com/platform/reference/patch_api-data-v1-opportunity-bulk-1.md): Validates the record details and updates if the ID already exists in the provided object, else inserts if it does not.
- [Get object opportunity record count and size on disk](https://developer.conga.com/platform/reference/get_api-data-v1-opportunity-summary-1.md): Returns a count of all records for the given object, and it's size on disk.
- [Execute single query](https://developer.conga.com/platform/reference/post_api-data-v1-opportunity-query-1.md): Validates and executes the query request for the given object and specifying whether the total record count should be included in the response.
- [Get all opportunity record types](https://developer.conga.com/platform/reference/get_api-data-v1-opportunity-recordtypes-1.md): Retrieves a list of all record types for the given object.
- [Upload documents](https://developer.conga.com/platform/reference/post_api-document-management-v1-documents.md): Uploads multiple documents and returns a list of metadata for each document. The following file extentions are supported: *.doc,.docx,.pdf,.zip,.png,.rtf,.txt,.jpg,.jpeg,.msg,.xls,.xlsx*
- [Delete documents by their IDs](https://developer.conga.com/platform/reference/delete_api-document-management-v1-documents.md): Deletes multiple documents and returns the status of the request.
- [Upload a single document](https://developer.conga.com/platform/reference/post_api-document-management-v1-documents-upload.md): Uploads a single document and returns the document's metadata. The following file extentions are supported: *.doc,.docx,.pdf,.zip,.png,.rtf,.txt,.jpg,.jpeg,.msg,.xls,.xlsx*
- [Initiate a multipart upload](https://developer.conga.com/platform/reference/post_api-document-management-v1-documents-multipart-uploads.md): Initiates multipart upload and returns the upload ID, key, and document metadata.
- [Upload a single part of a large file](https://developer.conga.com/platform/reference/put_api-document-management-v1-documents-documentid-multipart-uploads.md): Uploads a single part of a large file and returns the Etag and part number.
- [Complete multipart upload](https://developer.conga.com/platform/reference/post_api-document-management-v1-documents-documentid-multipart-uploads.md): Completes multipart upload by combining single uploaded parts and returns the status of the request.
- [Abort a multipart upload](https://developer.conga.com/platform/reference/delete_api-document-management-v1-documents-documentid-multipart-uploads.md): Aborts an incomplete multipart upload, deletes the metadata and version associated with it, and returns the status of the request.
- [Update a document](https://developer.conga.com/platform/reference/put_api-document-management-v1-documents-documentid.md): Updates a document and returns the updated document's metadata.
- [Delete a document by its ID](https://developer.conga.com/platform/reference/delete_api-document-management-v1-documents-documentid.md): Deletes a document and returns the status of the request.
- [Update the document metadata information for all versions](https://developer.conga.com/platform/reference/put_api-document-management-v1-documents-documentid-metadata.md): Updates the document metadata information for all versions and returns the status of the request.
- [Get a document's metadata by its ID](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-documentid-metadata.md): Retrieves the document metadata by passing a document ID as an input.
- [Get document information by its ID](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-id.md): Uses the version ID to retrieve a document's metadata.
- [Get a document by its ID](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-id-download.md): Downloads a document by ID.
- [Get documents by their IDs](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-bulk-1.md): Retrieves multiple documents by document ID.
- [Delete documents by object type and ID](https://developer.conga.com/platform/reference/delete_api-document-management-v1-documents-objects-objecttype-objectid.md): Deletes documents by object type and object ID.
- [Get documents by object type and ID](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-objects-objecttype-objectid.md): Retrieves documents by passing the object type and object ID as inputs
- [Get version details by object type and ID](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-objects-objecttype-objectid-versions.md): Retrieves document version details by passing the object type and object ID as inputs.
- [Clone a document](https://developer.conga.com/platform/reference/post_api-document-management-v1-documents-documentid-clone.md): Clones the document described by the document ID.
- [Check a document](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-documentid-exists.md): Checks whether the given document (documentId) exists.
- [Retrieve document versions](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-documentid-versions.md): Retrieves document versions by passing a document ID as an input.
- [Get a document by its ID and version](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-documentid-versions-versionid.md): Takes the document ID and version ID as inputs and retrieves specific document version.
- [Delete a versioned document](https://developer.conga.com/platform/reference/delete_api-document-management-v1-documents-documentid-versions-versionid.md): Deletes a document version by passing the document ID and version ID as inputs.
- [Search documents using advanced query parameters](https://developer.conga.com/platform/reference/post_api-document-management-v1-documents-search.md): Searches for documents using the provided query parameters and returns matching document metadata.
- [Get documents by object ID and file type](https://developer.conga.com/platform/reference/get_api-document-management-v1-documents-objects-objectid.md): Retrieves documents by passing file type and object ID as inputs.
- [Add a configuration](https://developer.conga.com/platform/reference/post_api-config-management-v1-configurations.md): Creates a new configuration and returns the request status.
- [Update a configuration](https://developer.conga.com/platform/reference/put_api-config-management-v1-configurations.md): Updates a configuration and returns the request status.
- [Delete a configuration](https://developer.conga.com/platform/reference/delete_api-config-management-v1-configurations-category-name.md): Deletes a configuration and returns the status of request.
- [Get a configuration](https://developer.conga.com/platform/reference/get_api-config-management-v1-configurations-category-name.md): When you pass a valid name and category to this endpoint, it returns configuration details.
- [Get multiple configurations](https://developer.conga.com/platform/reference/post_api-config-management-v1-configurations-category.md): When you pass a category and list of configuration names to this endpoint, it returns configuration details.
- [Get configurations by category](https://developer.conga.com/platform/reference/get_api-config-management-v1-configurations-category.md): Fetches all configurations that are part of the input category.
- [Export custom configuration](https://developer.conga.com/platform/reference/post_api-config-management-v1-configurations-export-1.md): For the configuration categories passed in the request body, exports the custom configuration (zipped, with a JSON file for each configuration category).
- [Import custom configuration](https://developer.conga.com/platform/reference/post_api-config-management-v1-configurations-import-1.md): Imports custom configuration. For duplicate configuration, the API throws an error. <p>**Note**: Upload a Zip file containg list of configurations.</p>
- [Get configuration categories](https://developer.conga.com/platform/reference/get_api-config-management-v1-configurations-categories-1.md): Fetches all configuration categories.
- [Render an email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-id-render.md): Fetches the email template information based on the email template ID and template render request.
- [Render an unsaved email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-render-1.md): Fetches the email template information based on the template render request. This API allows you to see a preview of an unsaved email template.
- [Create an email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates.md): Creates an email template based on the information passed in the request body.
- [Get the list of email templates based on filter and sort criteria](https://developer.conga.com/platform/reference/get_api-email-v1-email-templates.md): Returns a list of email templates filtered by access type or category, with support for sorting and pagination.
- [Create a template attachment for a given template ID](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-id-1.md): Creates a template attachment for the given template ID based on the email attachment information passed in the request body.
- [Get an email template by ID](https://developer.conga.com/platform/reference/get_api-email-v1-email-templates-id.md): Retrieves the email template based on the email template ID.
- [Update an email template](https://developer.conga.com/platform/reference/put_api-email-v1-email-templates-id.md): Updates the email template based on the email template ID and updated email template information.
- [Delete an email template](https://developer.conga.com/platform/reference/delete_api-email-v1-email-templates-id.md): Removes the email template based on the email template ID.
- [Delete a template attachment for a given template ID](https://developer.conga.com/platform/reference/delete_api-email-v1-email-templates-id-filename-delete-1.md): Removes the template attachment for the given email template ID based on the file name.
- [Delete all template attachments for a given template id at once](https://developer.conga.com/platform/reference/delete_api-email-v1-email-templates-id-delete-1.md): Removes all template attachments for the given email template ID.
- [Get the list of email templates based on search criteria](https://developer.conga.com/platform/reference/get_api-email-v1-email-templates-search.md): Returns a list of email templates that match the specified search criteria, with support for sorting and pagination.
- [Clone the email template](https://developer.conga.com/platform/reference/post_api-email-v1-email-templates-id-clone.md): Clones the email template based on the email template ID, with a new email template ID.
- [Create an email template category](https://developer.conga.com/platform/reference/post_api-email-v1-email-template-categories.md): Validates and creates an email template category.
- [Get the list of email template categories](https://developer.conga.com/platform/reference/get_api-email-v1-email-template-categories.md): Returns the list of email template categories.
- [Get an email template category by ID](https://developer.conga.com/platform/reference/get_api-email-v1-email-template-categories-id.md): Validates and retrieves the email template category based on the email template category ID.
- [Update an email template category](https://developer.conga.com/platform/reference/put_api-email-v1-email-template-categories-id.md): Validates and updates the email template category based on the email template category ID.
- [Delete the email template category](https://developer.conga.com/platform/reference/delete_api-email-v1-email-template-categories-id.md): Removes the email template category based on the email template category ID.
- [Send an email](https://developer.conga.com/platform/reference/post_api-email-v1-emails.md): Validates and sends an email based on the information provided in the request body and returns a status code in response.
- [Send bulk/mass email](https://developer.conga.com/platform/reference/post_api-email-v1-emails-bulk.md): Validates and sends bulk emails based on the information provided in the request body and returns a status code in response.
- [Verify an email domain](https://developer.conga.com/platform/reference/get_api-email-v1-emails-domain-verify.md): Checks whether the given domain/subdomain is registered and can be used for sending emails.
- [Send bulk/mass email using the v2 contract.](https://developer.conga.com/platform/reference/post_api-email-v2-emails-bulk.md)
- [Create a new email profile](https://developer.conga.com/platform/reference/post_api-email-v1-email-profiles.md): Validates and creates a new email profile.
- [Update an email profile](https://developer.conga.com/platform/reference/put_api-email-v1-email-profiles-name.md): Validates and updates the email profile based on the email profile Name.
- [Delete the email profile](https://developer.conga.com/platform/reference/delete_api-email-v1-email-profiles-name.md): Removes the email profile based on the email profile name.
- [Get an email profile by name](https://developer.conga.com/platform/reference/get_api-email-v1-email-profiles-name.md): Validates and retrieves the email profile based on the email profile name.
- [Email Status by EmailSendId and Recipients](https://developer.conga.com/platform/reference/post_api-email-v1-emails-status-batch.md): Fetches delivery status based on EmailSendId and Recipients.
- [Get delivery status of an email by JobId](https://developer.conga.com/platform/reference/get_api-email-v1-emails-jobs-jobid.md): Fetches delivery status based on JobId.
- [Automatically translate the schema of an object based on the provided metadata and target locale(s)](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-schema-auto-translate.md): This endpoint processes the given object metadata and generates translations for all translatable elements
 such as display names, descriptions, and field labels. The operation is executed asynchronously.
- [Automatically translate a set of text key-value pairs into the specified target locales](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-text-auto-translate.md): This endpoint processes the given text data and generates translations for target locales.
- [Retrieve all defined translation modules for the specified translation type](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-modules.md)
- [Retrieve a paginated list of translations for a given Type(String/Schema), with optional locale, module, search and filtering](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations.md)
- [Retrieve the total count of translations for a given type, with optional locale, module, and search filtering](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-type-count.md)
- [Retrieve translations using a cursor-based approach for a given type, with optional locale, module, and search filtering](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-type.md)
- [Bulk create translations for a specific locale](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-locales-locale.md)
- [Bulk update translations for a specific locale](https://developer.conga.com/platform/reference/put_api-localization-admin-v1-translations-locales-locale.md)
- [Bulk delete translations for a specific locale](https://developer.conga.com/platform/reference/delete_api-localization-admin-v1-translations-locales-locale.md)
- [Configure locales in Organization Locales configuration](https://developer.conga.com/platform/reference/put_api-localization-admin-v1-translations-organization-locales.md)
- [Get the current Organization Locales configuration](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-organization-locales.md)
- [Get the current Organization Locales Change Tracking Info](https://developer.conga.com/platform/reference/get_api-localization-admin-v1-translations-organization-locales-tracking-trackingid-status.md)
- [Export translations for the specified locale and modules as a CSV file](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-locales-locale-custom-export.md)
- [Import translations from a file for the specified locale using the v2 import logic](https://developer.conga.com/platform/reference/post_api-localization-admin-v1-translations-locales-locale-custom-import.md)
- [Get translations for multiple modules (Only supported for String type)](https://developer.conga.com/platform/reference/get_api-localization-v1-translations.md): Returns a dictionary of modules and their translations.
- [Get translations for a given keys and modules (Only supported for String type)](https://developer.conga.com/platform/reference/post_api-localization-v1-translations.md): Allows fetching multiple translations in a single request.
- [Get translated value for the user's locale](https://developer.conga.com/platform/reference/get_api-localization-v1-translations-module-key-1.md): Retrieves the translated value for the given module and key.
- [Get translated values for the user's locale](https://developer.conga.com/platform/reference/post_api-localization-v1-translations-module-bulk.md): Retrieves the translated values for the given module and list of keys.
- [Get translated values with parameters for the user's locale](https://developer.conga.com/platform/reference/post_api-localization-v1-translations-module-bulk-parameters.md): Retrieves the translated values with parameters for the given module and list of keys.
- [Get translated value and user locale](https://developer.conga.com/platform/reference/get_api-localization-v1-translations-module-key-parameters-1.md): Retrieves the translated value based on the input combination (Module, Key, and Parameters) given in the parameters.
- [Get translations by Module](https://developer.conga.com/platform/reference/get_api-localization-v1-translations-modules-module-bulk.md): Gets translations for the given module.
- [Retrieve custom code by project name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-name.md): Retrieves custom code for the given project name.
- [Delete a custom code by name](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-name-1.md): This endpoint validates and deletes the project Informations based on the name and returns OK response with string result otherwise returns exceptions.
- [Enable debug log](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-name-debuglog-1.md): Sets the EnableDebugLog flag for custom code for the given project name.
- [Get all custom codes](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode.md): Retrieves all available custom codes and their associated information.
- [Execute the custom code](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-execute.md): Executes the custom code.
- [Download the project](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-projectname-download.md): Downloads the custom code project with the given project name (in ZIP format).
- [Export the Projects or Resources based on the specified Type](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-migration-export-type-1.md): Exports the Projects or Resources based on the given Type parameter.
- [Import the Projects or Resources based on the specified Type](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-migration-import-type-1.md): Imports the Projects or Resources based on the given Type parameter.
- [Add a trusted API configuration](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-trusted-apis.md): Adds a trusted API configuration and returns the status of the request.
- [Get all trusted API configurations](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis.md): Retrieves a list of trusted API configurations.
- [Update a trusted API configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-trusted-apis-name.md): Updates a trusted API configuration and returns the status of the request.
- [Delete a trusted API configuration](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-trusted-apis-name.md): Deletes a trusted API configuration and returns the status of the request.
- [Retrieve a trusted API configuration by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis-name.md): Fetches trusted API configuration details based on the name.
- [Retrieve a trusted API configuration by URI](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis-uri.md): Fetches trusted API configuration details based on the URI of the trusted API configuration.
- [Retrieve all allowed HTTP verbs](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-apis-allowed-http-verbs.md): Fetches all allowed HTTP verbs.
- [Add a trusted object configuration](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-trusted-objects.md): Adds a trusted out-of-the-box (OOTB) object configuration.
- [List all trusted object configurations](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-objects.md): Returns a list of trusted out-of-the-box (OOTB) object configurations.
- [Update a trusted object configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-trusted-objects-name.md): Updates an existing trusted out-of-the-box (OOTB) object configuration.
- [Delete a trusted object configuration](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-trusted-objects-name.md): Removes an existing trusted out-of-the-box (OOTB) object configuration.
- [Get a trusted object configuration by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-objects-name.md): Returns the details of an existing trusted out-of-the-box (OOTB) object configuration.
- [List allowed operations](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-trusted-objects-allowed-operations.md): Returns a list of allowed operations.
- [Update callback contract mapping](https://developer.conga.com/platform/reference/put_api-extensibility-v1-callbacks.md): Updates the callback contract mapping with custom code project and class.
- [Get all callback contracts](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks.md): Retrieves all callback contract and project mapping information for each callback contract.
- [Get callback contract details](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-name.md): Retrieves callback contract details and mapping information based on the module and callback contract names.
- [Get callback custom code setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-settings.md): Fetches callback custom code setting configuration details.
- [Upsert callback custom code setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-callbacks-settings.md): If a callback custom code setting is already configured, it is updated; otherwise, a new one is created.
- [Get all modules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-modules.md): Retrieves a list of registered callback modules.
- [Get all callback contracts by module name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-callbacks-modules-modulename.md): Retrieves callback contract details and project mapping information for each callback contract by module name.
- [Retrieve a data change rule by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules-name.md): Retrieves the data change rule details for the given name.
- [Update a data change rule](https://developer.conga.com/platform/reference/put_api-extensibility-v1-servicehooks-datachangerules-name.md): Validates and updates the data change rule and returns the updated rule information.
- [Delete a data change rule](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-servicehooks-datachangerules-name.md): Validates and removes the given data change rule.
- [Insert a new data change rule](https://developer.conga.com/platform/reference/post_api-extensibility-v1-servicehooks-datachangerules.md): Validates and inserts the data change rule and returns the rule information.
- [Retrieve all data change rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules.md): Returns data change rules that meet the parameter conditions.
- [Retrieve all supported event types in service hook rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules-supported-event-types-1.md): Fetches all supported event types.
- [Get ServiceHooks cancellation token setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-datachangerules-cancellation-settings-1.md): Fetches ServiceHooks cancellation token setting configuration details.
- [Upsert ServiceHooks cancellation token setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-servicehooks-datachangerules-cancellation-settings-1.md): If a cancellation token setting is already configured, it is updated; otherwise, a new one is created.
- [Resolve a URI](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-resolve-1.md): Resolves the API resource's URI entry information.
- [Create a new API resource](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-1.md): Creates a new API resource.
- [Get all API resources](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-1.md): Retrieves a list of all API resources.
- [Get API resource information by resource name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-name-1.md): Retrieves the API resource information for the given API resource name.
- [Delete an API resource](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-api-resource-name-1.md): Validates and removes the API resource information based on the API resource name.
- [Clone an API resource](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-name-clone-1.md): Clones an existing (source) API resource and its associated URI entry information to a new API resource.
- [Create an API resource URI](https://developer.conga.com/platform/reference/post_api-extensibility-v1-customcode-api-resource-name-uri-entries-1.md): Inserts a new API resource URI entry and returns new resource URI entry information.
- [Get URIs by name or verb](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-name-uri-entries-1.md): Retrieves URI entries by name or HTTP verb.
- [Update URI entry information](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-api-resource-name-uri-entries-id-1.md): Updates a URI entry and returns updated URI entry information.
- [Delete a URI](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-customcode-api-resource-name-uri-entries-id-1.md): Removes a URI entry based on the API resource name and URI entry ID.
- [Get CustomAPI cancellation token setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-customcode-api-resource-cancellation-settings-1.md): Fetches CustomAPI cancellation token setting configuration details.
- [Upsert CustomAPI cancellation token setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-customcode-api-resource-cancellation-settings-1.md): If a cancellation token setting is already configured, it is updated; otherwise, a new one is created.
- [Retrieve a service hooks rule by name](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-name-1.md): Retrieves the service hooks rule details for the given name.
- [Update a service hooks rule](https://developer.conga.com/platform/reference/patch_api-extensibility-v1-servicehooks-rules-name-1.md): Validates and updates the service hooks rule and returns the updated rule information.
- [Delete a service hooks rule](https://developer.conga.com/platform/reference/delete_api-extensibility-v1-servicehooks-rules-name-1.md): Validates and removes the given service hooks rule.
- [Create a new service hooks rule](https://developer.conga.com/platform/reference/post_api-extensibility-v1-servicehooks-rules-1.md): Validates and creates the data change or schedule rule and returns the rule information.
- [Retrieve all service hooks rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-1.md): Returns service hooks rules that meet the parameter conditions.
- [Retrieve all supported event types in service hook rules](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-supported-event-types-1.md): Fetches all supported event types.
- [Get service hooks cancellation token setting configuration](https://developer.conga.com/platform/reference/get_api-extensibility-v1-servicehooks-rules-cancellation-settings-1.md): Fetches service hooks cancellation token setting configuration details.
- [Upsert service hooks cancellation token setting configuration](https://developer.conga.com/platform/reference/put_api-extensibility-v1-servicehooks-rules-cancellation-settings-1.md): If a cancellation token setting is already configured, it is updated; otherwise, a new one is created.
- [Deploy source artifact package](https://developer.conga.com/platform/reference/post_api-extensibility-v2-deployment-package-deploy-1.md): Deploys the source artifact package asynchronously. **Note:** Package may contain CustomCode, Configuration, Schema.
- [Promote a package to the target environment](https://developer.conga.com/platform/reference/post_api-extensibility-v2-deployment-package-promote-1.md): Promotes a package to a target environment using the provided integration user's credentials (client ID and secret) and Release URI information.<p>Note: - Use the GET ​/api​/extensibility​/v2​/deployment​/package​/{name}​/info endpoint to get the Release URI. - For more information on how to create the integration user and get the client ID and secret, see the [Adding Users](https://documentation.conga.com/en/advantage-platform-administration/current/conga-advantage-platform-for-administrators/managing-users/adding-users) topic.</p>
- [Track package deployment status](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-deploymentid-status-1.md): Gets the status of the package and any available resource for the given deployment ID.
- [Retrieve all data of deployment package history](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-history-1.md): Returns data of deployment package history that meet the parameter conditions.
             **isSnapshot=true** indicates that we want to fetch packages that are not eligible for promotion
             **isSnapshot=false** indicates that we want to fetch packages that are eligible for promotion
- [Retrieve resource deployment information for the specified package](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-package-name-history-1.md): Returns resource deployments for the specified package that meets the parameter criteria. Note:** Package may contain CustomCode, Configuration, Schema.
- [Retrieve package information for the specified package](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-package-name-info-1.md): Returns package's information along with ReleaseURI for the specified package that meets the parameter criteria.
- [Revert a custom code deployment package with given name](https://developer.conga.com/platform/reference/post_api-extensibility-v2-deployment-package-name-rollback-1.md): Reverts all custom code projects deployed with the given package name to the latest available version in history or delete the custom code if no history found. **Note:** This will not revert Configuration and Schema resources.
- [Get package deployment logs](https://developer.conga.com/platform/reference/get_api-extensibility-v2-deployment-deploymentid-logs-1.md): Retrieves package deployment's logs with a given deployment ID.
- [Get all search settings](https://developer.conga.com/platform/reference/get_api-search-v1-setting-1.md): Retrieves all objects' search settings.
- [Create a search setting](https://developer.conga.com/platform/reference/post_api-search-v1-setting-1.md): Creates a search setting for a particular object.
- [Update object search setting](https://developer.conga.com/platform/reference/put_api-search-v1-setting-objectname-1.md): Updates the search setting for a given object name.
- [Delete object search setting](https://developer.conga.com/platform/reference/delete_api-search-v1-setting-objectname-1.md): Deletes the search setting for a given object name.
- [Index a document](https://developer.conga.com/platform/reference/post_api-search-v1-document-index-1.md): Creates an index for the specified document.
- [Get data sync status of an object](https://developer.conga.com/platform/reference/get_api-search-v1-objectname-datasyncstatus-1.md): Gets data sync status (Elasticsearch and database) of the given object.
- [Get data sync status by tracking ID](https://developer.conga.com/platform/reference/get_api-search-v1-datasyncstatus-trackingid.md): Gets the data sync status for a specific tracking ID.
- [Get the data sync status of all objects](https://developer.conga.com/platform/reference/get_api-search-v1-datasyncstatus-1.md): Lists all objects and their data sync status (Elasticsearch and database).
- [Resync data for objects except Document](https://developer.conga.com/platform/reference/post_api-search-v1-resyncdata-1.md): Resync data of objects which have mismatch (Elasticsearch and database) count and their data sync will be initialized.
             Document object will not be processed here. to sync data of Documents, trigger manually using `api/search/v1/{objectName}/resyncdata`
- [Resync data for an object](https://developer.conga.com/platform/reference/post_api-search-v1-objectname-resyncdata-1.md): Resync data of an object which have mismatch (Elasticsearch and database) count and their data sync will be initialized.
- [Migrate Search RBAC settings](https://developer.conga.com/platform/reference/post_api-search-v1-rbac-migrate.md): Migrates Search RBAC settings by identifying missing RBAC fields in search settings and publishing a migration message if required.
- [Get field data types supported in global search configuration.](https://developer.conga.com/platform/reference/get_api-search-v1-global-search-data-types.md): Returns field data types supported in global search configuration.
- [Get search setting](https://developer.conga.com/platform/reference/get_api-search-v1-setting-objectname-1.md): Retrieves the search setting by object name.
- [Search an object](https://developer.conga.com/platform/reference/post_api-search-v1-objects-objectname-query-1.md): Searches an object using various query parameters (for example, Advanced, Fulltext, and Typeahead) and returns the results along with a count.<p>**Note**: If no search settings are configured for User, Role, and Object Permission objects, the API searches the database for object details.</p>
- [Search documents](https://developer.conga.com/platform/reference/post_api-search-v1-document-query-1.md): Searches an object using various query parameters (for example, Advanced, Fulltext, and Typeahead) and returns the results along with a count.
- [Search objects](https://developer.conga.com/platform/reference/post_api-search-v1-objects-multiple-query-1.md): Searches over multiple objects using various query parameters (for example, Advanced, Fulltext, and Typeahead) and returns the results along with the record count.<p>When searching the text across all the documents, the response provides the total DocumentCount (which indicates in how many documents the document search text was found) and the NoOfOccurrances count (which indicates how many times the document search text appeared in all documents).</p>
- [Retrieve fields from the search settings or database](https://developer.conga.com/platform/reference/get_api-search-v1-objects-objectname-indexedfields-1.md): Retrieves the list of fields first from the [search settings](https://documentation.conga.com/congaplatform/latest/creating-and-managing-search-settings-222430006.html), and if no fields are enabled for search for the object, it displays indexed fields from the database.
- [Get a list of objects for which the search setting is enabled](https://developer.conga.com/platform/reference/get_api-search-v1-setting-list-1.md): Retrieves a list of objects for which the search setting is enabled.
- [Global Search on configured objects](https://developer.conga.com/platform/reference/post_api-search-v1-global-query.md)
- [List scheduled jobs](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-1.md): Returns scheduled job details.
- [Get scheduled job details](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-jobname-1.md): Returns the scheduled job details based on the job name.
- [Delete a scheduled job](https://developer.conga.com/platform/reference/delete_api-scheduler-v1-jobs-jobname-1.md): Deletes a scheduled job and its execution history by job name.
- [Create a new cron scheduled job](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-cron-1.md): Creates a new cron scheduled job and returns the job name.
- [Create a one-time scheduled job](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-onetime-1.md): Creates a new scheduled job and returns the job's name.
- [Execute the scheduled job](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-jobname-execute-1.md): Executes and returns the executed scheduled job or an appropriate error message.
- [Update the scheduled job](https://developer.conga.com/platform/reference/put_api-scheduler-v1-jobs-jobname-cron-1.md): Updates and returns the scheduled job information or an appropriate error message.
- [Disable the scheduled job](https://developer.conga.com/platform/reference/put_api-scheduler-v1-jobs-jobname-disable-1.md): Disables a scheduled job by job name.
- [Enable scheduled job](https://developer.conga.com/platform/reference/put_api-scheduler-v1-jobs-jobname-enable-1.md): Enables a named scheduled job.
- [Get scheduled job execution history](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-jobname-execution-history-1.md): Returns the scheduled job execution history.
- [Export a scheduled job](https://developer.conga.com/platform/reference/get_api-scheduler-v1-jobs-jobname-export-1.md): Returns scheduled job information by name in a ZIP file.
- [Export all scheduled jobs](https://developer.conga.com/platform/reference/post_api-scheduler-v1-jobs-export-1.md): Exports all scheduled job information in a zip file, based on the appNamespace parameter.
- [Retrieve a currency rate by ID](https://developer.conga.com/platform/reference/get_api-currency-management-v1-currency-rates-id-1.md): Retrieves a currency rate for the given currency rate ID.
- [Update a currency rate](https://developer.conga.com/platform/reference/put_api-currency-management-v1-currency-rates-id-1.md): Updates a currency rate for the given currency rate ID.
- [Delete currency rate by ID](https://developer.conga.com/platform/reference/delete_api-currency-management-v1-currency-rates-id-1.md): Deletes a currency rate.
- [Add a new currency rate](https://developer.conga.com/platform/reference/post_api-currency-management-v1-currency-rates-1.md): Creates a new currency rate.
- [Get all currency rates](https://developer.conga.com/platform/reference/get_api-currency-management-v1-currency-rates-1.md): Returns all currency rates that meet the criteria.
- [Add multiple currency rates](https://developer.conga.com/platform/reference/post_api-currency-management-v1-currency-rates-bulk-1.md): Creates multiple currency rates.
- [Update multiple currency rates](https://developer.conga.com/platform/reference/put_api-currency-management-v1-currency-rates-bulk-1.md): Update multiple currency rates and returns the request status.
- [Retrieve effective currency rate](https://developer.conga.com/platform/reference/post_api-currency-management-v1-query-currency-rates-1.md): Retrieves the effective currency rate.
- [Retrieve effective currency rates](https://developer.conga.com/platform/reference/post_api-currency-management-v1-query-currency-rates-bulk-1.md): Retrieves the effective currency rates.
- [Retrieve converted currency](https://developer.conga.com/platform/reference/post_api-currency-management-v1-query-currency-conversion-1.md): Retrieves the converted currency.
- [Retrieve a frequency conversion rate by ID](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-frequency-conversion-rates-id-1.md): Retrieves a frequency conversion rate for the given frequency conversion rate ID.
- [Update a frequency conversion rate](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-frequency-conversion-rates-id-1.md): Updates a frequency conversion rate for the given frequency conversion rate ID.
- [Delete frequency conversion rate by ID](https://developer.conga.com/platform/reference/delete_api-conversion-management-v1-frequency-conversion-rates-id-1.md): Deletes frequency conversion rate.
- [Get all frequency conversion rates](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-frequency-conversion-rates-1.md): Returns all frequency conversion rates that meet the criteria.
- [Add a new frequency conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-frequency-conversion-rates-1.md): Creates a new frequency conversion rate.
- [Add multiple Frequency conversion rates](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-frequency-conversion-rates-bulk-1.md): Creates multiple frequency conversion rates.
- [Update multiple frequency conversion rates](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-frequency-conversion-rates-bulk-1.md): Updates multiple frequency conversion rates and returns the request status.
- [Retrieve effective frequency Conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-frequency-conversion-rates-1.md): Retrieves the effective frequency conversion rate.
- [Retrieve effective frequency conversion rates in bulk](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-frequency-conversion-rates-bulk-1.md): Retrieves the effective frequency conversion rates in bulk.
- [Retrieve converted frequency value](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-frequency-conversion-1.md): Retrieves the converted frequency value.
- [Check for liveness](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-health-live.md)
- [Check for readiness](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-health-ready.md)
- [Retrieve a UOM conversion rate by ID](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-uom-conversion-rates-id-1.md): Retrieves a UOM conversion rate for the given UOM conversion rate ID.
- [Update a UOM conversion rate](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-uom-conversion-rates-id-1.md): Updates a UOM conversion rate for the given UOM conversion rate ID.
- [Delete UOM conversion rate by ID](https://developer.conga.com/platform/reference/delete_api-conversion-management-v1-uom-conversion-rates-id-1.md): Deletes UOM conversion rate by ID.
- [Get all UOM conversion rates](https://developer.conga.com/platform/reference/get_api-conversion-management-v1-uom-conversion-rates-1.md): Returns all UOM conversion rates that meet the criteria.
- [Add a new UOM conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-uom-conversion-rates-1.md): Creates a new UOM conversion rate.
- [Add multiple UOM conversion rates](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-uom-conversion-rates-bulk-1.md): Creates multiple UOM conversion rates.
- [Update multiple UOM conversion rates](https://developer.conga.com/platform/reference/put_api-conversion-management-v1-uom-conversion-rates-bulk-1.md): Updates multiple UOM conversion rates and returns the request status.
- [Retrieve effective UOM conversion rate](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-uom-conversion-rates-1.md): Retrieves the effective UOM conversion rate.
- [Retrieve effective UOM conversion rates in bulk](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-uom-conversion-rates-bulk-1.md): Retrieves the effective UOM conversion rates in bulk.
- [Retrieve converted UOM value](https://developer.conga.com/platform/reference/post_api-conversion-management-v1-query-uom-conversion-1.md): Retrieves the converted UOM value.
- [Get audit history for a record](https://developer.conga.com/platform/reference/post_api-audit-v1-objects-objectname-records-recordid-field-history-tracking.md): Retrieves the audit history for a specific record. It returns a list of all changes made to the specified fields of the record.
- [Retrieves the translation audit history for a specific locale, module, and key.](https://developer.conga.com/platform/reference/get_api-audit-v1-translations-locales-locale-modules-module-keys-key-audit-history.md): Fetches the audit history of translations based on the provided locale, module, key, and translation type. This allows users to track changes made to translations over time for auditing purposes.
- [Add Fields to Field History Tracking](https://developer.conga.com/platform/reference/put_api-audit-v1-objects-objectname-field-history-tracking-config.md): Adds one or more fields to the specified object’s field history tracking configuration. This enables tracking changes to the added fields over time for auditing and reporting purposes.
- [Remove Object from Field History Tracking](https://developer.conga.com/platform/reference/delete_api-audit-v1-objects-objectname-field-history-tracking-config.md): Removes the specified object and all its associated fields from the field history tracking configuration. After removal, changes to these fields will no longer be tracked.
- [Get Field History Tracking Configuration](https://developer.conga.com/platform/reference/get_api-audit-v1-field-history-tracking-config.md): Retrieves all objects and their associated fields that are currently configured for field history tracking. Use this API to view which objects and fields have change tracking enabled.
- [Download a file using the specified file path and file name](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filename-download-1.md): Retrieves a file from the file store and returns it as a downloadable response.
 It handles the following:
 - URL decoding of the file path to support special characters
 - Determining the appropriate content type based on file extension
 - Setting response headers including content length and modified date
 - Adding file path information for client reference
 
 If the requested file is not found, it returns a 404 Not Found response.
- [Provide time-based public access to a file](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-shareduri-1.md): Generates a temporary URL that provides public access to a file for a limited time.
 The URL will be valid for the duration specified in the request's TTLSeconds parameter.
- [Download multiple files as a ZIP archive](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-download-1.md): Retrieves multiple files based on their names and file path, packages them into a ZIP archive, and returns the file for download.
 If any requested files are not found, appropriate error details are returned.
- [Get list of file names](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filenames-list-1.md): Returns a paginated list of files available at the specified path in the file store.
 It supports:
 - Pagination through continuation tokens for efficient retrieval of large file sets
 - Optional retrieval of file metadata tags
 - Configurable limits on the number of file names returned per request
 
 The response includes file names and optionally their associated metadata tags.
 For large directories, use the continuation token from the response to retrieve subsequent pages of results.
- [Retrieve detailed information about a specific file in the file store](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filename-info-1.md): Returns metadata about a file including:
 - Content type (MIME type)
 - File tags/metadata
 - File name and path information
 
 It provides file information without downloading the full file content, making it efficient for operations that require only file existence verification or metadata checks.
 If the file does not exist or cannot be accessed, a 404 Not Found response is returned.
- [Check if a file exists in the file store](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-filepath-filename-exists-1.md): Checks if a file exists at the specified path in the file store, ensuring availability before access.
 Common use cases include:
 - Validating file existence before performing operations on it
 - Pre-checking before initiating a download
 - Verifying if a previously requested file is still available
 
 The path is URL decoded to support special characters in file paths.
- [Upload a file to the file store with specified metadata and settings](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-filepath-filename-upload-1.md): Upload a file with additional configuration through form data:
 - The file content is sent as a multipart form file
 - The file name and path determine storage location
 - Optional metadata tags can be added
 - Optional file sharing settings can be configured
 - Optional file expiration policy can be set
 
 It enforces a maximum upload size limit defined in Constants.MAX_STREAM_UPLOAD_SIZE.
 For larger files, consider using the multipart upload endpoints instead.
- [Upload multiple files](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-bulk-1.md): Upload multiple files in a single request, including file contents and metadata.
 Each file can have unique tags, expiration settings, and shared URI configuration.
 Files are stored at the specified path.
- [Delete multiple files from the file store](https://developer.conga.com/platform/reference/delete_api-filestore-v1-files-bulk-1.md): Deletes multiple files at the given path with partial success handling. 
 Found files are deleted, while missing files return detailed error information. 
 Each file’s deletion status is tracked in the response.
- [Delete a file from the file store](https://developer.conga.com/platform/reference/delete_api-filestore-v1-files-1.md): Validates if the specified file exists at the given path and deletes it if found.
- [Delete all files in a specified folder location](https://developer.conga.com/platform/reference/delete_api-filestore-v1-folders-1.md): Deletes all files in the specified folder path.
 Note that this operation:
 - Deletes only files in the specified folder (not nested folders).
 - Is irreversible - deleted files cannot be recovered.
 - Returns details of all deleted files in the response.
- [Initiate a multipart upload process for a large file](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-multipart-uploads-1.md): Starts a multipart upload by creating an upload session.
 It returns an upload ID for use in subsequent API calls to:
 - Upload individual parts of the file (UploadPartAsync)
 - Complete the multipart upload (CompleteMultipartUploadAsync) 
 - Abort the multipart upload if needed (AbortMultipartUploadAsync)
 
 The multipart upload process allows to upload large files in smaller chunks,
 providing better reliability for large file transfers and the ability to pause/resume uploads.
- [Upload a single part of a large file in a multipart upload process](https://developer.conga.com/platform/reference/put_api-filestore-v1-files-multipart-uploads-1.md): Uploads a single part of a large file in a multipart upload session and returns the ETag and part number.
 This endpoint is used as part of the multipart upload workflow:
 1. First, initialize a multipart upload using InitiateMultipartUploadAsync
 2. Upload individual parts using this endpoint
 3. Complete the upload using CompleteMultipartUploadAsync
 
 The part number must be between 1 and 10,000, and parts must be uploaded sequentially.
 The same part number can be reused to replace a previously uploaded part.
- [Abort an incomplete multipart upload process](https://developer.conga.com/platform/reference/delete_api-filestore-v1-files-multipart-uploads-1.md): Cancels an in-progress multipart upload operation and removes any parts 
 that have already been uploaded. Use this endpoint when you need to:
 - Cancel an upload that is no longer needed
 - Handle error conditions where the upload cannot be completed
 - Clean up resources when an upload process is interrupted
 
 All previously uploaded parts associated with the specified uploadId will be deleted,
 and the upload ID will no longer be valid for future operations.
- [Complete a multipart upload process by combining all uploaded parts into the final file](https://developer.conga.com/platform/reference/post_api-filestore-v1-files-multipart-uploads-complete-1.md): This endpoint is the final step in the multipart upload workflow:
 1. Start with InitiateMultipartUploadAsync to get an uploadId
 2. Upload individual parts with UploadPartAsync
 3. Complete the process with this endpoint
 
 The request requires the uploadId from the initial request and a dictionary of part numbers 
 mapped to their ETags (received when each part is uploaded). This allows the system to
 verify all parts and combine them in the correct order.
 
 If successful, the file will be available at the specified file path.
- [Retrieve file size limitation information](https://developer.conga.com/platform/reference/get_api-filestore-v1-files-limits-1.md): This endpoint provides the current configuration limits for file operations:
 - Maximum allowed payload size for standard file uploads
 - Minimum file part size required for multipart uploads
 
 This information is useful for client applications to properly manage file uploads,
 especially when handling large files that require multipart upload functionality.
- [Create a new folder in the file store at the specified path](https://developer.conga.com/platform/reference/post_api-filestore-v1-folders-create-1.md): Creates a new folder structure within the file store.
 The folder is created at the specified folder path with the given folder name.
 If the parent path doesn't exist, it will give path does not exist validation error.
 
 Use this endpoint when you need to:
 - Create an organizational structure before uploading files
 - Create a dedicated space for a specific set of files
 - Generate folder hierarchies for structured data storage
- [Get all contents of a given folder](https://developer.conga.com/platform/reference/post_api-filestore-v1-folders-foldername-list-1.md): Returns details of files and folders for the given folder name and folder path.
 This endpoint retrieves the direct contents (files and subfolders) of a specified folder.
 The response includes metadata for each item and supports pagination through continuation tokens.
 
 Use this endpoint to:
 - Browse folder contents
 - List files in a specific location
 - Navigate through folder hierarchies
 
 The response can be paginated if there are many items in the folder.
- [Delete the contents of a specified folder in the file store](https://developer.conga.com/platform/reference/delete_api-filestore-v1-folders-delete-1.md): Deletes all contents within the specified folder path and folder name.
 The operation is performed asynchronously and returns the status of the deletion.
- [Get status of a folder operation by tracking ID](https://developer.conga.com/platform/reference/get_api-filestore-v1-folder-operation-trackingid-status-1.md): Returns the current status and details of a folder operation (such as delete, copy, or move)
 identified by the provided tracking ID. The response includes information such as the folder name, path,
 operation type, status, and progress.
- [Get the file from the CDN store](https://developer.conga.com/platform/reference/get_api-cdnstore-v1-files-filefullpath-1.md): Retrieves a file's details and contents from the CDN store.
- [Upload a file(upto 100 MB) to the CDN store](https://developer.conga.com/platform/reference/post_api-cdnstore-v1-files-filefullpath-1.md): Uploads a file (upto 100 MB) to the CDN store.
- [Delete a file](https://developer.conga.com/platform/reference/delete_api-cdnstore-v1-files-1.md): Validates if the specified file exists at the given path and deletes it if found.; otherwise, it returns an exception.
- [Delete multiple files](https://developer.conga.com/platform/reference/delete_api-cdnstore-v1-files-bulk-1.md): Validates if the specified files exist at the given path and deletes it if found.; otherwise, it returns an exception.
- [Create authentication configuration](https://developer.conga.com/platform/reference/post_api-external-endpoint-config-v1-credentials-1.md): Stores authentication credentials (OAuth2, Basic Auth, etc.) required to connect securely to an external platform such as Salesforce. Once created, these credentials can be referenced by endpoint configurations to authenticate requests.
- [Update authentication configuration](https://developer.conga.com/platform/reference/put_api-external-endpoint-config-v1-credentials-1.md): Updates stored authentication details, such as client secrets or passwords, for a specified external platform, such as Salesforce.
- [Retrieve authentication configuration](https://developer.conga.com/platform/reference/get_api-external-endpoint-config-v1-credentials-name-1.md): Returns the stored authentication details of a specific configuration used for securely connecting to an external service endpoint.
- [Delete authentication configuration](https://developer.conga.com/platform/reference/delete_api-external-endpoint-config-v1-credentials-name-1.md): Removes the stored authentication details for the specified configuration, preventing future connections to the external service endpoint.
- [Validate external endpoint schema](https://developer.conga.com/platform/reference/post_api-external-endpoint-config-v1-endpoints-validate-1.md): Validates the request and response metadata of an external endpoint against the expected JSON schema to ensure correct structure before execution.
- [Retrieve endpoint configuration](https://developer.conga.com/platform/reference/get_api-external-endpoint-config-v1-endpoints-id-1.md): Fetches the stored authentication details and configuration of an external service endpoint using its unique identifier, including URL, method, headers, and linked authentication.
- [Update endpoint configuration](https://developer.conga.com/platform/reference/put_api-external-endpoint-config-v1-endpoints-id-1.md): Updates the settings of a configured endpoint, such as changing the Salesforce API version, modifying the HTTP method, or adjusting headers and parameters.
- [Delete endpoint configuration](https://developer.conga.com/platform/reference/delete_api-external-endpoint-config-v1-endpoints-id-1.md): Deletes the specified external endpoint configuration and its stored authentication details.
- [Create endpoint configuration](https://developer.conga.com/platform/reference/post_api-external-endpoint-config-v1-endpoints-1.md): Creates a new external endpoint configuration by defining its URL, HTTP method, headers, parameters, request/response metadata, and linked authentication.
- [Retrieve all endpoint configurations](https://developer.conga.com/platform/reference/get_api-external-endpoint-config-v1-endpoints-1.md): Retrieves all stored authentication configurations used to connect to external service endpoints.


# Revenue Documentation

> CPQ and Digital Commerce

## Guides
- [CPQ API on Conga Platform - Use Cases](https://developer.conga.com/revenue/docs/cpq-api-on-conga-platform-use-cases.md)
- [User Authentication to Conga Platform](https://developer.conga.com/revenue/docs/user-authentication-to-conga-platform.md)
- [Getting the Application Context](https://developer.conga.com/revenue/docs/getting-the-application-context.md)
- [Retrieving Product Details](https://developer.conga.com/revenue/docs/retrieving-product-details.md)
- [Angular Applications](https://developer.conga.com/revenue/docs/angular-authentication.md): This page will help you authenticate your Angular application.
- [React Applications](https://developer.conga.com/revenue/docs/react-applications.md): This page will help you authenticate your React application.
- [Filtering](https://developer.conga.com/revenue/docs/filtering.md)
- [Pagination](https://developer.conga.com/revenue/docs/pagination.md)
- [Includes](https://developer.conga.com/revenue/docs/includes.md)
- [Sorting](https://developer.conga.com/revenue/docs/sorting.md)
- [Status and Error Codes](https://developer.conga.com/revenue/docs/status-and-error-codes.md)
- [Content Type](https://developer.conga.com/revenue/docs/content-type.md)

## API Reference
- [Get all AdHoc Groups.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adhoc-groups.md): Returns list of AdHoc Groups for the specified cart.
- [Create multiple AdHoc Groups.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-adhoc-groups.md): Creates a list of AdHoc Groups for the specified cart. Validates for duplicate names and sequences within the cart. Returns the created groups or validation errors.
- [Update multiple AdHoc Groups.](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adhoc-groups.md): Updates a collection of AdHoc Groups with new data. Returns the updated groups or validation errors.
- [Delete multiple AdHoc Groups.](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adhoc-groups.md): Deletes a list of AdHoc Groups from the specified cart. Returns the result of the delete operation.
- [Get an AdHoc Group by its Id.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adhoc-groups-adhocgroupid.md): Retrieves a single AdHoc Group by its unique Id. Returns 404 if the group does not exist.
- [Update a single AdHoc Group by its Id.](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adhoc-groups-adhocgroupid.md): Updates the specified AdHoc Group with new data. Returns the updated group or validation errors.
- [Delete a single AdHoc Group by its Id.](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adhoc-groups-adhocgroupid.md): Deletes the specified AdHoc Group from the cart. Returns the result of the delete operation.
- [Get cart adjustments](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adjustments-1.md): Retrieves the adjustments for the cart (by cart ID).
- [Create adjustments](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-adjustments-1.md): Creates one or more adjustments.
- [Update adjustments by cart](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adjustments-1.md): Updates one or more adjustment records for the given cartId.
- [Delete cart adjustments](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adjustments-1.md): Deletes one or more adjustments in a cart based on the cart ID in the endpoint request and the cart ID and adjustment IDs provided in the parameters.
- [Get cart adjustment details](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-adjustments-adjustmentid-1.md): Retrieves details of a cart's adjustments by adjustment ID.
- [Update adjustments by identifier](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-adjustments-adjustmentid-1.md): Update the adjustment fields for the cart and adjustment IDs given in the parameters.
- [Delete an adjustment by identifier](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-adjustments-adjustmentid-1.md): Deletes the adjustment record.
- [Delete adjustments for a line item](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-lineitemid-adjustments-1.md): Deletes adjustments for a specific line item.
- [Launches the cart for a given business object ID and business object type.](https://developer.conga.com/revenue/reference/post_api-cart-v1-business-objects-businessobjectid-carts-activate.md)
- [Returns the readonly cart for the given business object ID and business object type.](https://developer.conga.com/revenue/reference/get_api-cart-v1-business-objects-businessobjectid-carts-active.md)
- [Please use the endpoint `POST /api/cart/v1/business-objects/{businessObjectId}/carts/reactivate` instead. This is deprecated.](https://developer.conga.com/revenue/reference/post_api-cart-v1-business-objects-businessobjectid-reactivate.md): Syncs fields from quote to cart and re-evaluates config rule, pricing and formula for lineitems. Note: No OOTB field is getting updated as of now.
- [Reactivates the cart syncing the fields from quote to cart.](https://developer.conga.com/revenue/reference/post_api-cart-v1-business-objects-businessobjectid-carts-reactivate.md): Syncs fields from quote to cart and re-evaluates config rule, pricing and formula for lineitems. Supported OOTB fields to sync data from quote to cart are: Account, BillingPreferenc, BillToAccount, ShipToAccount, ExpectedStartDate, ExpectedEndDate, Location, Owner and PurchaseId Only OOTB field - PurchaseId, is supported to sync the data from quote to cart and then to line items.
- [Activate a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-activate-1.md): Activates a cart associated with the cart ID provided in the parameters. Only a cart with a New and Saved status can be activated. Carts in such other statuses as Finalized, Superseded, Suspended, Abandoned, or Deleted cannot be activated.
- [Migrate a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-migrate.md): Migrates a cart associated with the cart ID provided in the parameters. A cart with Abandoned or Superseded status cannot be migrated.
- [Get the latest active cart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-active-1.md): Gets the latest active cart, filtering carts with New and Saved status by default. Pass the quote ID in the parameters. If the cart for the provided quote does not exist, this API creates a new cart. For an existing cart, the saved cart ID is returned. For a newly created cart, the cart status is "New" and a new cart ID is generated. The following fields are passed from the quote header to the newly created cart: Account, Price List, Status, Business Object, Business Object Type, Cart Effective Date, Expected Start Date, Expected End Date, Location, Quote/Proposal, Pricing Date, Payment Term, and Cart Name.
- [Clone a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-clone-1.md): Clones a cart according to the primary lines no. given by the user or else clones the cart creating an exact copy of the entire cart with all its contents. The cloned cart is created in the new status. The cartID parameter is required. Set the price query parameter to true to price the cart. Clones a cart creating an exact copy of the entire cart with all its contents. The cloned cart is created in the new status. The cartID parameter is required. Set the price query parameter to true to price the cart. For Price true clones a cart according to the line no. given by the user but if nothing is given then clones the whole cart creating an exact copy of the entire cart with all its contents.
- [Retrieve Cart status](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-status-1.md): Returns a cart's status, filtered by line number. **Note:** Use either primaryLineNumbers or lineNumbers to filter your API responses. If you specify both, the API fetches results according to the primaryLineNumbers parameter. In adjustment lines, only the entry-level records (e.g., Price Rule Entry, Price Matrix Entry) are included. The parent records (e.g., Price Rule, Price Matrix) are not exposed or available in the context of adjustment lines.
- [Retrieve Configuration status](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-configstatus-1.md): Returns config status of the cart associated with a given cart ID. **Note**: Use either primaryLineNumbers or lineNumbers to filter your API responses.  If you specify both, the API fetches results according to the primaryLineNumbers parameter.
- [Get cart line numbers](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-line-numbers-1.md): Fetches and validates the line numbers for a given cart ID.
- [Apply promotion to the cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-promotion-1.md): Validates and applies a promotion to the given cart.
- [Check the cart out](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-order-1.md): Checks out the cart to create an order and order line items based on the given cart ID. The cart does not have to be in Finalized status to check out and create an order: it can be checked out to create an order even from the Draft status. This API returns the created order object with all the order line items. After order creation, the created order is in Draft status, and the cart’s status is Finalized. You can pass the following information for addition to the newly generated order.   * OrderAsync Name   * Accounts      * Sold To      * Ship To      * Bill To   * Primary Contact   * Comments (if any)
- [Check the cart out to create a quote](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-quote-1.md): Checks out the finalized cart to create a new quote/proposal. This API validates the following during runtime.   * The API finalizes the cart, validating all required configurations. If any condition is not met, the cart is not finalized, and the quote/proposal is not created.   * When there are no cart finalization errors, a new quote/proposal is created and associated with the cart ID passed in the parameters. The API passes the cart line items to the quote line items. To run this API, at least one product must be added to the cart. After the quote is created, the quote is in draft status, and the cart is in finalized status. The following information is created for the new quote.   * RFP due date   * Accounts     * Sold To     * Ship To     * Bill To   * Primary Contact   * Comments (if any) You can also create multiple quotes by passing the same cart ID.
- [Finalize a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-finalize-1.md): Finalizes the cart, completing product configuration. This API finalizes the cart when the final set of products and prices is confirmed. This API also validates the following during runtime:   * Whether any product is missing the required configuration. If so, it displays an error message.   * Whether any product requires repricing. If so, it displays an error message.   * Up to two levels of inclusion and exclusion constraint rules for a product, bundle, sub-bundle, and options belonging to a product family or product group.   * Inclusion and exclusion constraint rules across bundles.
- [Get finalized cart details](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-finalize-1.md): Validates and retrieves the finalized cart details for a given cart.
- [Validate the cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-validate-1.md): Validates a cart record for a given cartId and actionName.
- [Abandon a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-abandon-1.md): Validates and abandons a cart.
- [Ignore the rule action](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-rule-actions-ruleactionid-ignore-1.md): Validates and ignores a rule action for a given cart.
- [Get revalidation details](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-revalidation-1.md): Retrieves revalidation details for a given cart.
- [Apply revalidation](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-revalidation-1.md): Validates and applies the revalidation to a given cart.
- [Retrive display action details.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-displayaction-1.md): Fetches all display action details for the specified cart in the given flow.
- [GetConfigRulesOfCart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-rule-actions-1.md): Gets all the config rules for a given cart ID.
- [Get the applied rule actions](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-rule-actions-1.md): Retrieves the applied rule action for a given cart ID and primary line number.
- [GetRuleAction](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-triggered-rule-actions.md)
- [Processes the totals.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-totals.md)
- [Gets the line items group metadata.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-group-status.md)
- [Clone lines into existing cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-clone-lines.md)
- [Add line items to a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-1.md): Adds one or more standalone, bundle, option product, or other assets to the cart and creates a line item for each based on the request body details.
- [Update line items](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-items-1.md): Updates multiple line items in a cart based on details provided in the request body.The cart ID is passed as a mandatory parameter. This API validates the following during runtime:   * Validation constraint rules with multiple condition statements and action statements on product group and product family.   * Validation constraint rules with multiple condition statements and action statements across different option groups belonging to different bundles.   * Validation constraint rule for the Check on Finalization action on a product.   * Message validation constraint rule on a product. For example, a message is displayed based on a product selection.   * The minimum and maximum options for an option group are also checked when adding options to a bundle. For example, while creating the product option group, if the MaxOptions is set to 1, and if you add more than one option product in the cart, then an error message indicating the option ID or option group ID is displayed. This API updates the following inside a bundle:   * The quantity of an option inside a bundle   * The optional flag of an option inside a bundle   * The editable line item field of an option inside a bundle   * The quantity of a sub-bundle inside a bundle   * The optional flag of a sub-bundle inside a bundle   * The editable line item field of a sub-bundle inside a bundle Line items cannot be updated in a cart with Finalized, Superseded, or Deleted statuses. If line items are updated in such a cart, the API displays an error.
- [Retrieve line items from a cart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-items-1.md): Retrieves all line items associated with the cart ID provided in the parameters.The API returns:    * Cart header fields    * Primary line items    * Secondary line items associated with the primary line items, such as options and charge types.
- [Delete line items from a cart](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-1.md): Deletes one or more line items associated with the cart ID passed in the parameter. Products cannot be deleted from a cart with Finalized, Superseded, or Deleted status.  If line items are removed from such a cart, the API returns an error.
- [Clone cart line items](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-clone-1.md): Clones line items based on the primary line numbers passed in the request body. This API creates an exact copy of the lines along with the saved configuration. The cartId parameter is required. This API validates the following during runtime:   * All the selected primary line items for both standalone and bundle are cloned at once.   * Bundle line items are cloned along with all secondary line items.     * The product is copied with its configuration, including options.     * Pricing is re-evaluated to price the newly created line.   *  After cloning, all pricing calls are executed and the summary group is updated based on the latest pricing information.   * All cloned lines are added as new lines at the end of the cart.   * Any custom fields on the line items are also copied.   * Any price rules or price matrices included as part of pricing are also executed.   * Any manual adjustments applied to the line items are not copied.
- [Reprice cart items](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-reprice-1.md): Reprices one or more line items based on the primary line numbers passed in the request body and cart ID passed in the parameter.
- [Fetches the Cart Lineitem Persistance errors .](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-items-errors.md): This API provides detailed information on persistence failures within the system. Specifically, it retrieves a list of exceptions that have led to failures in the persistence flow, including issues encountered during ProcessPriceResponse and ProcessConfigResponse. By querying this API, you can obtain insights into the underlying errors affecting data persistence, helping in diagnostics and troubleshooting.
- [Get all carts](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-1.md): Retrieves the collection of all the carts.
- [Create carts](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-1.md): Creates multiple carts from a list.
- [Update carts](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-1.md): Updates multiple carts from a list.
- [Delete carts](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-1.md): Deletes multiple carts from a submitted list.
- [Get a cart](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-id-1.md): Retrieves a single cart by its identifier.
- [Update a cart](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-id-1.md): Updates a single cart by ID.
- [Delete a cart](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-id-1.md): Deletes a single cart by its identifier.
- [Add collaboration request.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-collaboration-request.md)
- [Get collaboration request details.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-collaboration-request.md)
- [Get collaboration request by ID.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-collaboration-request-id.md)
- [Update collaboration request.](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-collaboration-request-id.md)
- [Cancel/Delete collaboration request.](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-collaboration-request-id.md)
- [Merge collaboration request.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-collaboration-request-id-merge.md)
- [Submit for merge collaboration request.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-collaboration-request-id-submit-for-merge.md)
- [Gets the applicable rules.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applicable-rules.md)
- [Gets the applicable product attribute rules.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-rules.md)
- [Gets the applicable product attribute rules.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applicable-attribute-rules.md)
- [Gets the applied product attribute rules asynchronous.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-attribute-rules.md)
- [Gets the applicable field expression asynchronous.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applicable-field-expression.md)
- [Gets the applied field expression asynchronous.](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-applied-field-expression.md)
- [Export line items from a cart as a downloadable CSV file.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-export.md): Exports all line items associated with the specified cartId. The resulting CSV contains: <list type="bullet"><item><description>Cart header fields</description></item><item><description>Primary line items</description></item><item><description>Secondary line items (options, charge types, etc.)</description></item></list> Provide `primaryLineNumbers` and `lineNumbers` in the request body.
- [Imports ProductId and Quantity line items into the specified cart from a CSV file.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-import.md): **CSV Requirements** - File must contain exactly two columns: ProductId and Quantity. - Columns must appear in the exact order shown. - **ProductId must be a valid GUID.** - **Quantity must be a whole number greater than or equal to 0.** - **Maximum 5000 data rows allowed (excluding header).** - **Maximum file size: 100 MB.** - First row must be a valid header. - No extra or missing columns allowed.              **Example** ``` ProductId,Quantity 550e8400-e29b-41d4-a716-446655440000,10 8d12b9f5-3e37-4e11-a98a-4455ae76a280,5 ```
- [Add an incentive](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-incentives-1.md): Applies a new incentive to a cart.
- [Delete an incentive](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-incentives-1.md): Removes an incentive from a cart.
- [Update an incentive](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-incentives-1.md): Updates an incentive on a given cart.
- [Get an incentive](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-incentives-1.md): Retrieves an incentive from a given cart.
- [lock API used to acquire lock/request for edit access.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-lock.md)
- [This API is use to unlock/release the lock on cart](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-unlock.md)
- [Query the lookup field object records based on lookup field setting.](https://developer.conga.com/revenue/reference/post_api-cart-v1-lookupfield-data-query-1.md)
- [Get price waterfall detail](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-items-lineitemid-waterfallchart-1.md): Retrieves the price waterfall detail based on the given cart's line item ID.
- [Get price waterfall detail by chart ID](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-items-lineitemid-waterfallchart-chartid-1.md): Retrieves the price waterfall detail based on the given cart's line item ID and chart ID.
- [Get summary group associated price waterfall detail](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-summarygroups-summarygroupid-waterfallchart-1.md): Retrieves the summary group of price waterfall chart details based on the given cart's ID and summary group ID.
- [Get summary group associated price waterfall detail by chart ID](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-summarygroups-summarygroupid-waterfallchart-chartid-1.md): Retrieves the summary group of price waterfall chart details based on the given cart's ID, summary group ID and waterfall chart ID.
- [Get batch price waterfall details for all line Items](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-waterfallchart.md): Retrieves the price waterfall detail based on the all line item.
- [Launch a cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-quotes-quoteid-carts-activate-1.md): Launches the cart for a given quote.
- [Gets the active cart](https://developer.conga.com/revenue/reference/get_api-cart-v1-quotes-quoteid-carts-active.md)
- [Add ramp line items to the cart line item](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-itemid-auto-ramps-1.md): Creates ramp line items for the given cartId and lineItemId parameters.
- [Delete ramp line items](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-ramp-lines-1.md): Deletes the ramp line for a given cart ID.
- [Update ramp line items](https://developer.conga.com/revenue/reference/put_api-cart-v1-carts-cartid-items-ramp-lines-1.md): Updates ramp line items for a given cart ID.
- [Create mass ramp lines](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-ramp-lines.md): Creates mass ramp lines for the given cartId
- [Add a line item to a ramp line](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-itemid-ramp-lines-1.md): Adds a ramp line item to the given cart ID and line item ID.
- [Update a ramp line item](https://developer.conga.com/revenue/reference/put_api-cart-v1-carts-cartid-items-itemid-ramp-lines-1.md): Updates a single ramp line item for the given cart ID and line item ID.
- [Delete a ramp line item](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-itemid-ramp-lines-1.md): Deletes a ramp line identified by cart ID and line item ID.
- [Splits a ramp line item into multiple periods](https://developer.conga.com/revenue/reference/put_api-cart-v1-carts-cartid-items-itemid-ramp-lines-split.md): Splits a single ramp line item for the given cart ID and line item ID into multiple periods based on the split configuration.
- [Generate ramp periods](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-ramp-periods.md): Generate the ramp periods for the given cart ID
- [Create ramp lines for one or more cart line items](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-ramps.md): Create ramp line for the given cartId and line item(s) with ramp parameters.
- [Add ramp lines to already ramped line items](https://developer.conga.com/revenue/reference/put_api-cart-v1-carts-cartid-items-ramps.md): Adds ramp line items
- [Update existing ramp lines](https://developer.conga.com/revenue/reference/patch_api-cart-v1-carts-cartid-items-ramps.md): Update existing ramp lines
- [Delete ramp line items](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-ramps.md): Deletes the ramp line for a given cart ID.
- [Perform the estimated rebate details for a cart.](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-rebate-estimates.md)
- [Get summary groups](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-summarygroups-1.md): Retrieves the summary groups for the given cart id.
- [Add summary group records to the cart](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-summarygroups-1.md): Adds summary groups for the given cart ID to reconfigure existing cart use cases.
- [Update summary groups by cart](https://developer.conga.com/revenue/reference/put_api-cart-v1-carts-cartid-summarygroups-1.md): Updates summary groups for the given cart ID, based on user adjustments.
- [Update ad hoc summary groups with user changes](https://developer.conga.com/revenue/reference/put_api-cart-v1-carts-cartid-summarygroups-adhoc-1.md): Updates ad hoc summary groups for the given cart id.
- [Create usage price tiers for a line item](https://developer.conga.com/revenue/reference/post_api-cart-v1-carts-cartid-items-itemid-usage-tiers-1.md): Adds usage price tiers for the cartId and lineItemId given in the parameters.
- [Update usage price tiers for a line item](https://developer.conga.com/revenue/reference/put_api-cart-v1-carts-cartid-items-itemid-usage-tiers-1.md): Updates the usage price tiers for a given cartId and lineItemId. <b>Note:</b> The object must have an ID to update the usage price tier.
- [Delete usage price tiers](https://developer.conga.com/revenue/reference/delete_api-cart-v1-carts-cartid-items-itemid-usage-tiers-1.md): Deletes the usage price tiers for the given cartId and lineItemId.
- [Get usage price tiers by line item](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-items-itemid-usage-tiers-1.md): Retrieves the usage price tiers for the given cartId and lineItemId.
- [Get bundle details](https://developer.conga.com/revenue/reference/get_api-cart-v1-carts-cartid-bundle-linenumber-details-1.md): Retrieves the bundle details for a given cart ID and line number. It includes option groups, child option groups, options, and any sub-bundles.
- [Retrieve all products in a category](https://developer.conga.com/revenue/reference/get_categories-categoryid-products-1.md): Retrieves all active products associated with the provided category ID and price list ID. This can be the ID of the leaf category, sub-category, or root category.
 <p>For a leaf category, the API returns all products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories. By default, the API returns the following fields with results sorted alphabetically by Product Name.</p><ul><li>Product Name</li><li>Product Code</li><li>Product Description</li><li>Product Family</li><li>List Price</li><li>Charge Type</li><li>The image associated with the product.</li></ul>
- [Retrieve all service products in a category](https://developer.conga.com/revenue/reference/post_categories-categoryid-services.md): Retrieves all active service products associated with the provided category ID and price list ID. This can be the ID of the leaf category, sub-category, or root category.
 <p>For a leaf category, the API returns all service products associated with it. If the ID of the root or sub-category (not a leaf category ID) is provided, the API returns all the products associated with all child categories. By default, the API returns the following fields with results sorted alphabetically by Product Name.</p><ul><li>Product Name</li><li>Product Code</li><li>Product Description</li><li>Product Family</li><li>List Price</li><li>Charge Type</li><li>The image associated with the product.</li></ul>
- [List categories](https://developer.conga.com/revenue/reference/get_categories-1.md): Retrieves all or a filtered list of categories based on provided parameters. For example, passing the price list ID retrieves all categories associated with that price list ID.
 <p> The API returns the list of categories with such details as category ID, category name, description, hierarchy ID, and the category's parent and child categories.</p><p>The API also executes visibility rules at runtime. The API executes one or more visibility rules on the root category and retrieves the list of categories. These visibility rules can include or exclude specific categories. The visibility rule must be associated with the price list to be executed at runtime.</p>
- [Get category details](https://developer.conga.com/revenue/reference/get_categories-categoryid-1.md): Retrieves the details of a category and its child categories by category ID and price list ID. The API returns such category details as category name, description, and hierarchy ID. The API also returns details of a sub-category's parent and child categories.
 <p> When you pass a category ID, the API retrieves all products associated with it in the price list. When you pass <i>All</i> as the category ID, the API retrieves all products across all categories for the price list.</p>
- [Fetch favorite by ID](https://developer.conga.com/revenue/reference/get_favorites-id-1.md)
- [Delete a favorite](https://developer.conga.com/revenue/reference/delete_favorites-id-1.md)
- [Update a favorite](https://developer.conga.com/revenue/reference/patch_favorites-id-1.md)
- [Preview favorite by ID](https://developer.conga.com/revenue/reference/get_favorites-id-preview.md)
- [List favorites by price list](https://developer.conga.com/revenue/reference/get_favorites-1.md): Retrieves a list of active favorites associated with the provided Price List ID.
- [Create favorites](https://developer.conga.com/revenue/reference/post_favorites-1.md): Creates favorites based on your business requirements.
- [Delete the favorite records](https://developer.conga.com/revenue/reference/delete_favorites-1.md)
- [Add favorite to a cart](https://developer.conga.com/revenue/reference/post_favorites-id-addtocart-cartid-1.md): Adds a favorite to the cart identified in cartId.
- [Publish favorite to a pricelist](https://developer.conga.com/revenue/reference/post_favorites-id-publish-1.md): Publishes a favorite for the given pricelist.
- [Delete the line-items from within the Favorite](https://developer.conga.com/revenue/reference/delete_favorites-id-items.md)
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-jobid-1.md): Retrieves job status details for the given job.
- [Get account locations](https://developer.conga.com/revenue/reference/get_locations-1.md)
- [Retrieve a price list](https://developer.conga.com/revenue/reference/get_price-lists-active-1.md)
- [List products by price list](https://developer.conga.com/revenue/reference/get_products-1.md): Retrieves details of active products associated with the provided price list ID. The API only retrieves active products with an active price list and price list item. The API also applies visibility rules and only retrieves relevant products. 
 <p>The API searches, sorts, filters, and applies pagination on the retrieved result.</p><p>For example, retrieve a list of products where the product name is "Product A", sort the result by product name.</p><p>The API returns the list of products in a price list and details of the following fields, among others.</p><ul><li>Product Name</li><li>Product Code</li><li>Product Description</li><li>Product Family</li><li>Product Type</li><li>Configuration Type</li><li>Has Attributes</li><li>Configuration Type</li><li>Option products (if provided product is a bundle) including the default bundle options</li><li>The image associated with the product</li><li>List Price</li><li>Charge Type</li></ul>
- [Get a product's details](https://developer.conga.com/revenue/reference/get_products-productid-1.md): Retrieves the details of a product (productId). The API only retrieves active products with an active price list and price list item.
 <p>The API returns details of the following fields, among others.</p><ul><li>Product Name</li><li>Product Code</li><li>Associated Categories</li><li>Associated Attributes</li><li>Configuration Type</li><li>List Price</li><li>Charge Type</li><li>Options products (if the provided product is a bundle)</li></ul>
- [Searches the search text in bundle context (option groups, options, attribute groups, attributes)](https://developer.conga.com/revenue/reference/get_products-productid-search.md): Retrieves the list where the search text matches.
- [Retrieve products by ID](https://developer.conga.com/revenue/reference/post_products-details-1.md): Retrieves product details for multiple products listed by product ID.
- [Compare products](https://developer.conga.com/revenue/reference/post_products-compare-1.md): Compares the attributes of a list of products by productId.
- [List service products](https://developer.conga.com/revenue/reference/post_services.md): Retrieves details of active service products associated with the provided price list ID. The API only retrieves active products with an active price list and price list item. The API also applies visibility rules and only retrieves relevant products. 
 <p>The API searches, sorts, filters, and applies pagination on the retrieved result.</p><p>For example, retrieve a list of products where the product name is "Product A", sort the result by product name.</p><p>The API returns the list of products in a price list and details of the following fields, among others.</p><ul><li>Product Name</li><li>Product Code</li><li>Product Description</li><li>Product Family</li><li>Product Type</li><li>Configuration Type</li><li>Has Attributes</li><li>Configuration Type</li><li>Option products (if provided product is a bundle) including the default bundle options</li><li>The image associated with the product</li><li>List Price</li><li>Charge Type</li></ul>
- [Search products](https://developer.conga.com/revenue/reference/post_search-1.md): Applies search filters in the catalog to retrieve one or more products that satisfy the search filter criteria provided in the parameters and the request body. To filter out a product you can use the following facets/search criteria. 
  <ul><li>Product Type(E.g., Equipment or service)</li><li>Family(E.g., Software or hardware)</li><li>Configuration Type(E.g., Standalone or bundle)</li><li>A custom multi-picklist field called AdminAuto_CustomMultiPicklistField_c(E.g., Bundle1, Bundle 2)</li></ul><p>Please note that the search filter that you are passing must be associated with the category ID on which you are performing the search.</p><p>This API also does multiple search criteria to filter out the product, it considers one or more of the conditions using AND/OR association.For example, to search within the family facet (Software or hardware) the facet value will only take the OR logic.But to search products across the Family facet and Product Type facet, the AND logic will be applicable.This API also sorts records in ascending order and applies pagination on the retrieved result.</p><p>Pass the Pricelist ID and Category ID in the header and select the Search Type in the query parameters to call this API.When you pass a specific Category ID, the search filters will be applied to all products associated with that specific category ID.When you pass Category ID as <b>All</b>, the search filters will be applied to all the products across all the categories. The Pricelist ID and Search Type are mandatory fields.You can also use the Filter and Includes query parameter to deepen your search by passing the categories and pricelist items.When you do not pass the category ID in the header or pass an empty request body, the API returns all the products without any facets/search filter.</p>
- [Search products using typeahead](https://developer.conga.com/revenue/reference/get_search-typeahead-1.md): Searches for products using typeahead search, an autosuggest method that predicts search results and gives users suggestions when they enter one or more letters related to their search.
 <p>This API searches and retrieves products based on the query parameters that you have passed.You must select the Search-Type query parameter as <b>Product</b> to run this API.For example, to search for products that contain the letter �a�, select the Search-Type query parameter to product, and under the Query parameter, enter the letter �a�. Executing this API displays all the products that have the letter �a� in their Product Name, Description, and Product code.If you do not pass any Query parameters, all the products will be retrieved. The PriceList ID in the header is a mandatory field to execute this API.</p>
- [List order lines](https://developer.conga.com/revenue/reference/get_order-parentid-orderlineitems-1.md): Returns the list of order line items for an Order.
- [Create many order line items](https://developer.conga.com/revenue/reference/post_order-parentid-orderlineitems-1.md): Creates multiple order line items for an Order.
- [Fetch lineitem by id.](https://developer.conga.com/revenue/reference/get_order-parentid-orderlineitems-id-1.md): Returns the details of an order line item based on its ID.
- [Update order line item](https://developer.conga.com/revenue/reference/patch_order-parentid-orderlineitems-id-1.md): Updates the order line items for a specific order.
- [Activate Order line items](https://developer.conga.com/revenue/reference/post_order-parentid-orderlineitems-activate-1.md): Adds one or more order line items to the collection.
- [Activate Bulk Order Line Items](https://developer.conga.com/revenue/reference/post_orders-orderlineitems-activate-1.md): This endpoint allows activating order line items in bulk for multiple orders. The API processes large volumes efficiently and activates valid order lines even if some lines fail validation within the same request.
- [Confirm an Order](https://developer.conga.com/revenue/reference/post_orders-id-confirm-1.md): Confirms an order based on its order ID.
- [Cancel an Order](https://developer.conga.com/revenue/reference/post_orders-id-cancel-1.md): Cancels an order based on its order ID.
- [List Orders](https://developer.conga.com/revenue/reference/get_orders-1.md): Returns a paginated list of orders
- [Create Orders](https://developer.conga.com/revenue/reference/post_orders-1.md): Adds one or more orders to the collection.
- [Update Orders](https://developer.conga.com/revenue/reference/patch_orders-1.md): Updates one or more orders in the collection
- [Delete Orders](https://developer.conga.com/revenue/reference/delete_orders-1.md): Deletes multiple orders
- [Fetch an Order](https://developer.conga.com/revenue/reference/get_orders-id-1.md): Returns a single order by identifier.
- [Update an Order](https://developer.conga.com/revenue/reference/patch_orders-id-1.md): Updates a single order by identifier
- [Delete an order](https://developer.conga.com/revenue/reference/delete_orders-id-1.md): Deletes an order by identifier
- [Activate Orders](https://developer.conga.com/revenue/reference/post_orders-id-activate-1.md): Activate an existing order
- [Creates child records](https://developer.conga.com/revenue/reference/post_orders-orderid-create-child-records-1.md): Creates child records for an Order
- [Bulk activate multiple orders.](https://developer.conga.com/revenue/reference/post_orders-activate-1.md): Activates multiple orders in a single request. Each order must provide its unique identifier and the date it is ready for activation.
- [Amend order process](https://developer.conga.com/revenue/reference/post_orders-id-change-1.md): Initiates change order process by copying an order for amendment.
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-id-2.md): Retrieves job status details for the given job or record.
- [Update many order line item](https://developer.conga.com/revenue/reference/patch_order-parentid-orderlineitems.md): Updates the order line items for a specific order.
- [Accept order change](https://developer.conga.com/revenue/reference/post_orders-id-accept-change.md): Accepts the changes made to an order during the change order process.
- [Revert order change](https://developer.conga.com/revenue/reference/post_orders-id-revert-change.md): Revert the changes made to an order during the change order process.
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-jobid-2.md): Retrieves job status details for the given job.
- [Accept a quote and create an order](https://developer.conga.com/revenue/reference/post_quotes-id-accept-1.md): Accepts a specified quote in any approval stage other than Accepted. 
 Creates an order and order line items based on the quote’s header and line item details. 
 Creates an order in draft stage with a Pending pricing status. The order inherits the following header fields, among others:
 <ul><li>Account</li><li>Sold To</li><li>Bill To</li><li>Primary Contact</li></ul><p>The order line items inherit the following fields, among others:</p><ul><li>Configuration Type</li><li>Charge Type</li><li>Price Type</li><li>Adjustments</li></ul>
- [Upsert a quote](https://developer.conga.com/revenue/reference/post_quotes-upsert-quote-1.md): Upserts an existing quote.
- [Clone quote](https://developer.conga.com/revenue/reference/post_quotes-id-clone-1.md): Clones a quote based on the internal quote ID.
- [Clone external quote](https://developer.conga.com/revenue/reference/post_quotes-externalid-clone-quote-1.md): Clones a quote based on the external quote ID.
- [Retrieve quotes](https://developer.conga.com/revenue/reference/get_quotes-1.md): Retrieves list of quotes.
- [Create quotes](https://developer.conga.com/revenue/reference/post_quotes-1.md): Creates one or more quotes with details provided in the request body. The API returns the IDs of the newly created quotes and their structure.
- [Update quotes](https://developer.conga.com/revenue/reference/patch_quotes-1.md): Updates one or more quotes.
- [Delete quotes](https://developer.conga.com/revenue/reference/delete_quotes-1.md): Deletes one or more quote records.
- [Retrieve a quote](https://developer.conga.com/revenue/reference/get_quotes-id-1.md): Retrieves the details of a quote based on the quote ID provided in the parameters.
 <param>The API returns the details of quote object</param>
- [Update a quote](https://developer.conga.com/revenue/reference/patch_quotes-id-1.md): Updates the quote with details provided in the request parameter. The API returns the ID of the updated quote and its structure.
- [Delete a quote](https://developer.conga.com/revenue/reference/delete_quotes-id-1.md): Deletes the quote where the quote ID matches the ID provided in the parameter.
- [Create agreement from a quote](https://developer.conga.com/revenue/reference/post_quotes-id-agreement-1.md): Create an agreement from a quote, where the quote ID matches the ID provided in the parameter.
- [Change a cart's assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-change-1.md): Changes the list of assets provided for a given cart.
- [Terminate a cart's assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-terminate-1.md): Terminates the assets listed for a given cart.
- [Renew a cart's assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-renew-1.md): Renews the listed assets for a given cart.
- [Configure an asset](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-change-configuration-1.md): Changes the configuration of an asset provided for a given cart.
- [Get termination date](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-cartid-termination-date-1.md): Gets the default asset termination date based on the callback.
- [Change quantity](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-change-quantity-1.md): Updates the quantity characteristic of assets in a given cart's asset list. This API updates the associated or implied quantity that any asset has. The AssetChangeQuantityRequest request parameter lists items the API can act on. You can change the quantities of multiple assets in a single request.
- [Suspend assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-suspend-1.md): Suspends the listed assets by date. This API suspends an existing asset based on the suspension date. It remains suspended until the suspension end date.
- [Resume assets](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-resume-1.md): Resumes the listed assets.
- [Restore line items](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-restore-1.md): Restores line-item fields to their original values from the asset line item.
- [Swap an asset](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-cartid-swap-1.md): Swaps an asset with any eligible replacement product, effective a given date.
- [Calculates metrics for asset termination based on the provided termination date](https://developer.conga.com/revenue/reference/post_api-asset-v1-terminate-preview-1.md)
- [List asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-cartid-1.md): Retrieves all asset line items for the given account(s).
- [List asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-1.md): Retrieves all asset line items for the given account(s).
- [Fetch grouping summary of asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-assets-group-summary-1.md): Retrieves Grouped summary of asset line items for the given account(s) based on the grouping field.
- [Get child asset line items](https://developer.conga.com/revenue/reference/get_api-asset-v1-parentassetid-assets-1.md): Retrieves all the child asset line items (primary, secondary, and option) associated with a parent bundle (excluding the parent bundle record).
- [Get assets by co-termination criteria](https://developer.conga.com/revenue/reference/get_api-asset-v1-assetid-coterm-1.md): Retrieves assets with identical values in specified criteria fields within the same account. Primarily used to amend asset co-termination during quantity changes.
- [List related purchased assets for given asset ids](https://developer.conga.com/revenue/reference/post_api-asset-v1-assets-related-purchases.md): Retrieves all related purchased assets for the given assetId(s).
- [/api/asset/v1/product/{productId}/replacement-products](https://developer.conga.com/revenue/reference/get_api-asset-v1-product-productid-replacement-products-1.md)
- [Retrieve attributes](https://developer.conga.com/revenue/reference/get_attributes-1.md): Retrieves the collection of attributes.
- [Create attributes](https://developer.conga.com/revenue/reference/post_attributes-1.md): Creates attributes based on the details provided in the request.
- [Update attributes](https://developer.conga.com/revenue/reference/patch_attributes-1.md): Updates one or more attribute records.
- [Delete attributes](https://developer.conga.com/revenue/reference/delete_attributes-1.md): Deletes one or more attributes based on the attribute IDs provided in the request body. 
 
  This API returns one or more records with each record ID's delete status.
- [Retrieve an attribute](https://developer.conga.com/revenue/reference/get_attributes-id-1.md): Retrieves a single attribute record.
- [Update an attribute](https://developer.conga.com/revenue/reference/patch_attributes-id-1.md): Updates a single attribute record.
- [Delete an attribute](https://developer.conga.com/revenue/reference/delete_attributes-id-1.md): Deletes an attribute based on the attribute ID provided in the parameters. 
 
  This API returns record ID's delete status.
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-jobid-3.md): Retrieves job status details for the given job.
 If includeChildJobs is true then it will return all the child jobs for the given jobId.
   
 OperationType
   
 ValidateBatchData -> Detailed validation error messages
   
 GenerateBatchReport -> Report link
- [Get multiple job status](https://developer.conga.com/revenue/reference/post_job-status.md): Retrieves all job status details for the given jobIds.
 If includeChildJobs is true then it will return all the child jobs for the given jobId.
   
 OperationType
   
 ValidateBatchData -> Detailed validation error messages
   
 GenerateBatchReport -> Report link
- [Delete job by JobId and also its associated child jobs](https://developer.conga.com/revenue/reference/delete_job-status.md): Delete job by JobId and also delete its child jobs
- [Retrieve active account](https://developer.conga.com/revenue/reference/accounts-3.md): Retrieves active account pricelist
- [Retrieve AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-parentid-entries.md): Retrieves the list of AttributeConstraintRuleEntries.
- [Create AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/post_attribute-constraint-rules-parentid-entries.md): Creates multiple AttributeConstraintRuleEntries.
- [Update AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules-parentid-entries.md): Updates multiple AttributeConstraintRuleEntries.
- [Delete AttributeConstraintRuleEntries](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules-parentid-entries.md): Deletes multiple AttributeConstraintRuleEntries.
- [Retrieve an AttributeConstraintRuleEntry](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-parentid-entries-id.md): Retrieves a single AttributeConstraintRuleEntry by ID.
- [Update an AttributeConstraintRuleEntry](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules-parentid-entries-id.md): Updates an existing AttributeConstraintRuleEntry.
- [Delete an AttributeConstraintRuleEntry](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules-parentid-entries-id.md): Deletes an AttributeConstraintRuleEntry.
- [Create AttributeConstraintRuleEntries using a CSV file.](https://developer.conga.com/revenue/reference/post_attribute-constraint-rules-parentid-entries-import.md)
- [Get the list of AttributeConstraintRuleEntries as a CSV file.](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-parentid-entries-export.md)
- [Retrieve AttributeConstraintRules](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules.md): Retrieves all Attribute Constraint Rules existing in the system.
 
  The API returns the list of Attribute Constraint Rules.
- [Create AttributeConstraintRules](https://developer.conga.com/revenue/reference/post_attribute-constraint-rules.md): Creates one or more Attribute Constraint Rules based on the details provided in the request body.
 
  The API returns the structure of newly created Attribute Constraint Rules.
- [Update AttributeConstraintRules](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules.md): Updates one or more Attribute Constraint Rules based on the details provided in the request body.
 
  When executed, the API returns the ID and the structure of the updated Attribute Constraint Rules.
- [Delete AttributeConstraintRules](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules.md): Deletes one or more AttributeConstraintRules based on the list of AttributeConstraintRule Ids provided in the request body.
- [Retrieve an AttributeConstraintRule](https://developer.conga.com/revenue/reference/get_attribute-constraint-rules-id.md): Retrieves a single AttributeConstraintRule record.
- [Update an AttributeConstraintRule](https://developer.conga.com/revenue/reference/patch_attribute-constraint-rules-id.md): Updates a single AttributeConstraintRule by its identifier.
- [Delete an AttributeConstraintRule.](https://developer.conga.com/revenue/reference/delete_attribute-constraint-rules-id.md): Deletes a single AttributeConstraintRule by its identifier.
- [Retrieve attribute group members](https://developer.conga.com/revenue/reference/get_attribute-groups-parentid-attributes-1.md): Retrieves a collection of attribute group members based on the parent attribute group.
- [Create attribute group members](https://developer.conga.com/revenue/reference/post_attribute-groups-parentid-attributes-1.md): Creates one or more attribute group members to the collection. The parent attribute group is automatically filled.
- [Update attribute group members](https://developer.conga.com/revenue/reference/patch_attribute-groups-parentid-attributes-1.md): Updates one or more attribute group members in the collection. Parent reassignment is not allowed.
- [Delete attribute group members](https://developer.conga.com/revenue/reference/delete_attribute-groups-parentid-attributes-1.md): Deletes one or more attribute group members from the collection.
- [Retrieve attribute group member](https://developer.conga.com/revenue/reference/get_attribute-groups-parentid-attributes-id-1.md): Retrieves a single attribute group member of an attribute group record.
- [Update an attribute group member](https://developer.conga.com/revenue/reference/patch_attribute-groups-parentid-attributes-id-1.md): Updates a single attribute group member of an attribute group record.
- [Delete an attribute group member](https://developer.conga.com/revenue/reference/delete_attribute-groups-parentid-attributes-id-1.md): Deletes a single attribute group member of an attribute group record.
- [Retrieve attribute groups](https://developer.conga.com/revenue/reference/get_attribute-groups-1.md): Retrieves the collection of attribute groups.
- [Create attribute groups](https://developer.conga.com/revenue/reference/post_attribute-groups-1.md): Creates mone or more attribute groups based on the details provided in the request body.
 
  When executed, the API returns the ID and the structure of the newly created attribute group.
- [Update attribute groups](https://developer.conga.com/revenue/reference/patch_attribute-groups-1.md): Updates one or more attribute groups based on the details provided in the request body.
 
  When executed, the API returns the ID and the structure of the updated attribute group.
- [Delete attribute groups](https://developer.conga.com/revenue/reference/delete_attribute-groups-1.md): Deletes one or more attribute groups based on the input provided in the request body. Upon deletion of an attribute group, the API deletes the records of association between attribute group with attributes and product.
- [Retrieve an attribute group](https://developer.conga.com/revenue/reference/get_attribute-groups-id-1.md): Retrieves a single attribute group record.
- [Update an attribute group](https://developer.conga.com/revenue/reference/patch_attribute-groups-id-1.md): Updates a single attribute group record.
- [Delete an attribute group](https://developer.conga.com/revenue/reference/delete_attribute-groups-id-1.md): Deletes a single attribute group record.
- [Retrieve attribute matrices](https://developer.conga.com/revenue/reference/get_attribute-matrices-1.md): Retrieves all attribute matrices existing in the system. If a product ID or an attribute ID is specified, the API retrieves attribute matrices associated with them.
 
  The API returns the list of attribute matrices.
- [Create attribute matrices](https://developer.conga.com/revenue/reference/post_attribute-matrices-1.md): Creates one or more attribute matrices based on the details provided in the request body. The attribute matrix can be created for product scope, and it can be active or deactivated upon creation.
 
  The API returns the structure of newly created attribute matrices.
- [Update attribute matrices](https://developer.conga.com/revenue/reference/patch_attribute-matrices-1.md): Updates one or more attribute matrices based on the details provided in the request body.
 
  When executed, the API returns the ID and the structure of the updated attribute matrices.
- [Delete attribute matrices](https://developer.conga.com/revenue/reference/delete_attribute-matrices-1.md): Deletes one or more attribute matrices based on the list of attribute matrix IDs provided in the request body.
- [Retrieve an attribute matrix](https://developer.conga.com/revenue/reference/get_attribute-matrices-id-1.md): Retrieves a single attribute matrix record.
- [Update an attribute matrix](https://developer.conga.com/revenue/reference/patch_attribute-matrices-id-1.md): Updates a single attribute matrix by its identifier.
- [Delete an attribute matrix](https://developer.conga.com/revenue/reference/delete_attribute-matrices-id-1.md): Deletes a single attribute matrix by its identifier.
- [Retrieve attribute matrix entries](https://developer.conga.com/revenue/reference/get_attribute-matrices-parentid-entries-1.md): Retrieves the list of attribute matrix entries.
- [Create attribute matrix entries](https://developer.conga.com/revenue/reference/post_attribute-matrices-parentid-entries-1.md): Creates multiple attribute matrix entries.
- [Update attribute matrix entries](https://developer.conga.com/revenue/reference/patch_attribute-matrices-parentid-entries-1.md): Updates multiple attribute matrix entries.
- [Delete attribute matrix entries](https://developer.conga.com/revenue/reference/delete_attribute-matrices-parentid-entries-1.md): Deletes multiple attribute matrix entries.
- [Retrieve an attribute matrix entry](https://developer.conga.com/revenue/reference/get_attribute-matrices-parentid-entries-id-1.md): Retrieves a single attribute matrix entry by ID.
- [Update an attribute matrix entry](https://developer.conga.com/revenue/reference/patch_attribute-matrices-parentid-entries-id-1.md): Updates an existing attribute matrix entry.
- [Delete an attribute matrix entry](https://developer.conga.com/revenue/reference/delete_attribute-matrices-parentid-entries-id-1.md): Deletes an attribute matrix entry.
- [Create AttributeMatrixEntries using a CSV file.](https://developer.conga.com/revenue/reference/post_attribute-matrices-parentid-entries-import-1.md): This API imports attribute matrix entries from a CSV file. The CSV file should have attribute names as column headers in the first row, followed by rows containing the corresponding attribute values. Each data row creates a new AttributeMatrixEntry with an auto-generated GUID, a name in the format "AVMEntry-{GUID}", and attributes mapped from the CSV columns. Empty values are treated as null. The file must have a .csv extension.
- [Get the list of AttributeMatrixEntries as a CSV file.](https://developer.conga.com/revenue/reference/get_attribute-matrices-parentid-entries-export-1.md): Exports attribute matrix entries to a CSV file. Retrieves all entries for the specified parent attribute matrix and generates a CSV file with attribute names as headers and corresponding values in rows. If no entries exist, the CSV file will contain only the header row with attribute names from the parent matrix definition. The exported file is named "AVMEntries-{ParentId}.csv".
- [Retrieve a category](https://developer.conga.com/revenue/reference/get_categories-id-1.md): Retrieves a single category record.
- [Update a category](https://developer.conga.com/revenue/reference/patch_categories-id-1.md): Updatess a single category record.
- [Delete a category](https://developer.conga.com/revenue/reference/delete_categories-id-1.md): Deletes a single category based on the category ID provided in the parameter. The API deletes the specific category record and records of association of the specific category with its products.
- [Retrieve categories](https://developer.conga.com/revenue/reference/get_categories-2.md): Retrieves a list of all categories that exist in the system. The "filter" parameter only supports category name and category id for this API.
- [Create categories](https://developer.conga.com/revenue/reference/post_categories-1.md): Creates one or more category based on the input provided in the request body.
 
  The API returns structure of each category created, with details provided in the request body.
- [Update categories](https://developer.conga.com/revenue/reference/patch_categories-1.md): Updates one or more categories based on the details provided in the request body.
- [Delete categories](https://developer.conga.com/revenue/reference/delete_categories-1.md): Deletes one or more categories based on the list of category IDs provided in the request body.
 
  The API deletes category records and records of association of category with products and price lists.
- [Add an existing category along with child categories and product associations under given destination category id.](https://developer.conga.com/revenue/reference/post_categories-id-add.md): Add an existing category along with child categories and product associations under given destination category id.
- [Add multiple existing categories under another category](https://developer.conga.com/revenue/reference/post_categories-category-bulk.md): Add multiple existing categories under given category id.
- [Get price lists](https://developer.conga.com/revenue/reference/get_categories-categoryid-price-lists-1.md): Gets price list records for a given category. Your request can set
 the number of records returned per page and the total number of pages.
- [Retrieve a product category](https://developer.conga.com/revenue/reference/get_categories-id-products-1.md): Retrieves a single product category.
- [Retrieve product categories](https://developer.conga.com/revenue/reference/get_categories-parentid-product-categories-1.md): Retrieves the product category records for a category.
- [Create product categories](https://developer.conga.com/revenue/reference/post_categories-parentid-product-categories-1.md): Creates multiple product categories.
- [Update product categories](https://developer.conga.com/revenue/reference/patch_categories-parentid-product-categories-1.md): Updates multiple product categories.
- [Delete product categories](https://developer.conga.com/revenue/reference/delete_categories-parentid-product-categories-1.md): Deletes one or more product categories from a specified product based on the parameters and request body.
- [Retrieve a product category](https://developer.conga.com/revenue/reference/get_categories-parentid-product-categories-id-1.md): Retrieves a product category by ID.
- [Update a product category](https://developer.conga.com/revenue/reference/patch_categories-parentid-product-categories-id-1.md): Updates a product category.
- [Delete a product category](https://developer.conga.com/revenue/reference/delete_categories-parentid-product-categories-id-1.md): Deletes a product category by ID.
- [Retrieve deep clone status](https://developer.conga.com/revenue/reference/get_clone-status-id-1.md): Retrieves deep clone status.
- [List related cloneable objects](https://developer.conga.com/revenue/reference/get_clone-objectname-supported-objects-1.md): Gets a list of related cloneable objects for a given source entity.
- [Create a clone of an object](https://developer.conga.com/revenue/reference/post_objectname-objectid-clone-1.md): Creates a clone of the object with the specified identifier.
- [Get constraint rule actions](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-actions-1.md): Retrieves all constraint rule actions in a constraint rule, with their details. Use query parameters to narrow the results further.
 
  When executed, this API returns all constraint rule actions in a constraint rule.
- [Create constraint rule actions](https://developer.conga.com/revenue/reference/post_constraint-rules-parentid-actions-1.md): Creates one or more constraint rule actions in a specific constraint rule. It can create a maximum of 100 constraint rule actions.
 
  When executed, this API returns a unique constraint rule action ID (string) that CPQ generates automatically.
- [Update constraint rule actions](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-actions-1.md): Updates specific fields on one or more constraint rule actions. It can update any field except the constraint rule action ID, and returns the updated constraint rule action or actions.
- [Delete constraint rule actions](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-actions-1.md): Deletes multiple constraint rule actions.
- [Get a constraint rule action](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-actions-id-1.md): Retrieves a single constraint rule action in a constraint rule, with its details.
- [Update a constraint rule action](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-actions-id-1.md): Updates a single constraint rule action in a constraint rule.
- [Delete a constraint rule action](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-actions-id-1.md): Deletes a single constraint rule action in a constraint rule.
- [Retrieve ConstraintRuleActionExpression](https://developer.conga.com/revenue/reference/get_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): Retrieves all ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns all ConstraintRuleActionExpressions in a ConstraintRuleAction.
- [Create ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/post_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): creates one or more ConstraintRuleActionExpressions in a specific ConstraintRuleAction. It can create a maximum of 1000 ConstraintRuleActionExpressions. It can create multiple ConstraintRuleActionExpressions for the same FieldExpression or multiple FieldExpressions. To create multiple ConstraintRuleActionExpressions, pass one array for each ConstraintRuleActionExpressions record in the API request.
  When executed, this API returns a unique ConstraintRuleActionExpressions ID (string) that CPQ automatically generates.
- [Update ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): Updates specific fields on one or more ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
 
  When executed, this API returns the updated ConstraintRuleActionExpressions or items.
- [Delete ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_constraint-rule-actions-parentid-constraint-rule-action-expressions.md): Delete ConstraintRuleActionExpressions
- [Retrieve a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/get_constraint-rule-actions-parentid-constraint-rule-action-expressions-id.md): Retrieves a ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns a ConstraintRuleActionExpressions in a ConstraintRuleAction.
- [Update a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_constraint-rule-actions-parentid-constraint-rule-action-expressions-id.md): Updates specific fields on specified ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
 
  When executed, this API returns the updated ConstraintRuleActionExpressions.
- [Delete a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_constraint-rule-actions-parentid-constraint-rule-action-expressions-id.md): Deletes a specified ConstraintRuleActionExpressions in a ConstraintRuleAction.
 
  When executed, this API returns the delete status of associated record ID.
- [Retrieve lookup records for FieldExpression](https://developer.conga.com/revenue/reference/get_constraint-rule-actions-id-field-expressions.md): Retrieves the lookup records for a specific FieldExpression based on the identifier.
- [Retrieve constraint rule conditions](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-conditions-1.md): Retrieves all constraint rule conditions in a constraint rule, with their details. Use query parameters to further narrow down the retrieved results.
 
  When executed, this API returns all constraint rule conditions in a constraint rule.
- [Create constraint rule conditions](https://developer.conga.com/revenue/reference/post_constraint-rules-parentid-conditions-1.md): Creates one or more constraint rule conditions in a specific constraint rule. It can create a maximum of 100 constraint rule conditions.
 
  When executed, this API returns a unique constraint rule condition ID (string) that CPQ generates automatically.
- [Update constraint rule conditions](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-conditions-1.md): Updates specific fields on one or more constraint rule conditions. It can update any fields except the constraint rule condition ID.
 
  When executed, this API returns the updated constraint rule condition or conditions.
- [Delete constraint rule conditions](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-conditions-1.md): Deletes one or more constraint rule conditions from a constraint rule.
 
  When executed, this API returns one or more records with each record ID's delete status.
- [Retrieve a constraint rule condition](https://developer.conga.com/revenue/reference/get_constraint-rules-parentid-conditions-id-1.md): Retrieve a single constraint rule condition in a constraint rule, with its details.
- [Update a constraint rule condition](https://developer.conga.com/revenue/reference/patch_constraint-rules-parentid-conditions-id-1.md): Updates a single constraint rule condition in a constraint rule.
- [Delete a constraint rule condition](https://developer.conga.com/revenue/reference/delete_constraint-rules-parentid-conditions-id-1.md): Deletes a single constraint rule condition in a constraint rule.
- [Retrieve constraint rules](https://developer.conga.com/revenue/reference/get_constraint-rules-1.md): Retrieves all constraint rules with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns all constraint rules.
- [Create constraint rules](https://developer.conga.com/revenue/reference/post_constraint-rules-1.md): one or more constraint rules. It can create a maximum of 1000 constraint rules. To create multiple constraint rules, pass multiple arrays of code in the API request (one array for each constraint rule record).
 
  When executed, this API returns a unique constraint rule ID (string) that CPQ automatically generates.
- [Update constraint rules](https://developer.conga.com/revenue/reference/patch_constraint-rules-1.md): Updates a specific fields on one or more constraint rules. It can update any fields except the constraint rule ID.
 
  When executed, this API returns the updated constraint rules or constraint rules.
- [Delete constraint rules](https://developer.conga.com/revenue/reference/delete_constraint-rules-1.md): Deletes one or more constraint rules. It can delete 1000 constraint rules in one go. If a constraint rule is deleted, the constraint rule conditions and actions associated with it are also deleted. Permissions are required to delete constraint rules.
 
  When executed, this API returns one or more records with each record ID's delete status.
- [Retrieve a constraint rule](https://developer.conga.com/revenue/reference/get_constraint-rules-id-1.md): Retrieves a constraint rule based on the constraint rule ID passed in the path parameter.
- [Update a constraint rule](https://developer.conga.com/revenue/reference/patch_constraint-rules-id-1.md): Updates a specific fields on a constraint rule based on the constraint rule ID passed in the path parameter.
 
  When executed, this API returns the updated constraint rule.
- [Delete a constraint rule](https://developer.conga.com/revenue/reference/delete_constraint-rules-id-1.md): Deletes a constraint rule based on the constraint rule ID passed in the path parameter. Permissions are required to delete a constraint rule.
 
  When executed, this API returns one or more records with each record ID's delete status.
- [Retrieve ConstraintRuleActionExpression](https://developer.conga.com/revenue/reference/get_field-expressions-parentid-constraint-rule-action-expressions.md): Retrieves all ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns all ConstraintRuleActionExpressions in a ConstraintRuleAction.
- [Create ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/post_field-expressions-parentid-constraint-rule-action-expressions.md): creates one or more ConstraintRuleActionExpressions in a specific ConstraintRuleAction. It can create a maximum of 1000 ConstraintRuleActionExpressions. It can create multiple ConstraintRuleActionExpressions for the same FieldExpression or multiple FieldExpressions. To create multiple ConstraintRuleActionExpressions, pass one array for each ConstraintRuleActionExpressions record in the API request.
  When executed, this API returns a unique ConstraintRuleActionExpressions ID (string) that CPQ automatically generates.
- [Update ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_field-expressions-parentid-constraint-rule-action-expressions.md): Updates specific fields on one or more ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
 
  When executed, this API returns the updated ConstraintRuleActionExpressions or items.
- [Delete ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_field-expressions-parentid-constraint-rule-action-expressions.md): Delete ConstraintRuleActionExpressions
- [Retrieve a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/get_field-expressions-parentid-constraint-rule-action-expressions-id.md): Retrieves a ConstraintRuleActionExpressions in a ConstraintRuleAction, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns a ConstraintRuleActionExpressions in a ConstraintRuleAction.
- [Update a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/patch_field-expressions-parentid-constraint-rule-action-expressions-id.md): Updates specific fields on specified ConstraintRuleActionExpressions. It can update any field except the ConstraintRuleActionExpressions ID.
 
  When executed, this API returns the updated ConstraintRuleActionExpressions.
- [Delete a ConstraintRuleActionExpressions](https://developer.conga.com/revenue/reference/delete_field-expressions-parentid-constraint-rule-action-expressions-id.md): Deletes a specified ConstraintRuleActionExpressions in a ConstraintRuleAction.
 
  When executed, this API returns the delete status of associated record ID.
- [Retrieve lookup records for ConstraintRuleAction](https://developer.conga.com/revenue/reference/get_field-expressions-id-constraint-rule-actions.md): Retrieves the lookup records for a specific ConstraintRuleAction based on the identifier.
- [Retrieve field expressions](https://developer.conga.com/revenue/reference/get_field-expressions-1.md): Retrieves the collection of field expressions.
- [Create field expressions](https://developer.conga.com/revenue/reference/post_field-expressions-1.md): Creates multiple field expressions.
- [Update field expressions](https://developer.conga.com/revenue/reference/patch_field-expressions-1.md): Updates multiple field expressions.
- [Delete field expressions](https://developer.conga.com/revenue/reference/delete_field-expressions-1.md): Deletes multiple field expressions.
- [Retrieve a field expression](https://developer.conga.com/revenue/reference/get_field-expressions-id-1.md): Retrieves a single field expression by its identifier.
- [Update a field expression](https://developer.conga.com/revenue/reference/patch_field-expressions-id-1.md): Updates a single field expression.
- [Delete a field expression](https://developer.conga.com/revenue/reference/delete_field-expressions-id-1.md): Deletes a single field expression by its identifier.
- [List flows](https://developer.conga.com/revenue/reference/get_flows.md): Retrieves the list of the flows.
- [Create flows](https://developer.conga.com/revenue/reference/post_flows.md): Creates one or more custom flows based on the request body.The API also creates display action settings and display column settings with default values, which can be overriden or updated using the settings endpoints.
- [Get a flow by name](https://developer.conga.com/revenue/reference/get_flows-flowname.md): This API can be used to retrieve a single flow record.
- [Update a flow](https://developer.conga.com/revenue/reference/put_flows-flowname-1.md): updates a flow based on the flow name provided in the parameter.
- [Delete a flow](https://developer.conga.com/revenue/reference/delete_flows-flowname.md): Deletes a flow based on the flow name provided in the parameter.
- [Create flow actions](https://developer.conga.com/revenue/reference/post_flows-flowname-actions.md): Creates 1 or more flow actions.
- [Update flow actions](https://developer.conga.com/revenue/reference/put_flows-flowname-actions.md): Creates, updates, and deletes flow actions based on the request body, for the flow passed in the parameter.
- [Retrieve actions associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-actions.md): Retrieves actions for the flow passed in the parameter, based on the display action settings configured and the display type. The actions are defined for the following <b>Display Types</b> which correspond to different pages in CPQ:
  <ul><li>Cart Page</li><li>Catalog Page </li><li>Bundle Page </li><li>Attribute Page </li><li>Resolve</li><li> configuration Page </li><li>Installed Products Page</li><li>Analyze Quote </li><li>Cart Summary </li></ul><p> The API also retrieves the following details associated with the actions: </p><ul><li> Sequence: Defines sequence in which actions are displayed on CPQ pages. </li><li>Action: API names of the actions.For example, <i>Finalize</i> and<i>Addmoreproduct</i>.
 </li><li>Action Label Name: Actions lables that displayed on the CPQ pages. For example, <b>Finalize</b> and <b>Close Cart</b>. </li><li> Display As: Defines whether given action is displayed as an<i> Action</i> or<i> Task</i> on the CPQ page. </li><li> Action Area: Defines position on the page where action is displayed.For example, <i>Left</i>, <i>Right</i>, and<i> Center</i>. </li><li> Action Style Class: Defines the style class used for the action. </li><li> Action Page: The name of the Visualforce or custom page that is invoked for the respective action along with action params. </li><li> Behavior: Defines the action page''s behavior on opening the page in a dialog window, new window, or the same window. </li><li> Action type: Defines the action type. For example, <i>Quick Redirect</i>,<i> Save</i>, and<i> Quick Save</i>. </li><li>Is Enabled: Indicates whether the action is enabled or disabled. </li><li>Always Display: Indicates that the actions are displayed even is they are disabled.The disabled actions are grayed out on the CPQ pages. </li></ul>
- [Create flow displays](https://developer.conga.com/revenue/reference/post_flows-flowname-displays.md): Creates 1 or more displays for a flow.
- [Update flow displays](https://developer.conga.com/revenue/reference/put_flows-flowname-displays.md): Updates 1 more displays for a flow record.
- [Retrieve column displays associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-displays.md): Retrieves column displays for the flow passed in the parameter, based on the display column settings configured and the display type. The columns are defined for the following <b>Display Types</b> which correspond to different sections on a CPQ page: 
 <ul><li>Cart Line Item</li><li>Cart Total Item</li><li>Mass Update</li><li>Cost Line Item</li><li>Usage Price tiers</li><li>Price Ramps</li><li>Tierd Price</li><li>Related Price</li><li>Line Item Waterfall</li><li>Option Line Item</li></ul><p>The API also retrieves the following details associated with the columns: </p><ul><li> Sequence: Defines sequence in which columns are displayed on CPQ pages.</li><li> Field Name: The name of the column</li><li> Is Editable: Indicates whether the column is editable in CPQ.</li><li>Style: Defines the column text alignment using CSS styles.</li><li> Style Class: Defines the style class used for the column.</li></ul>'
- [Create settings](https://developer.conga.com/revenue/reference/post_flows-flowname-settings-settingname-1.md): Creates a setting or child setting for a flow.
- [Update custom settings associated with a flow](https://developer.conga.com/revenue/reference/put_flows-flowname-settings-settingname-1.md): Updates the following categories of setting associated with a flow name provided in the parameters. 
 <ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to update the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release.</p>
- [Retrieve custom settings associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-settings-settingname-1.md): Retrieves the following categories of setting associated with a flow name provided in the parameters. 
 <ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to retrieve the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release</p>
- [Delete settings](https://developer.conga.com/revenue/reference/delete_flows-flowname-settings-settingname-1.md): Deletes a setting or child setting for a flow.
- [Create settings](https://developer.conga.com/revenue/reference/post_flows-flowname-settings-settingname-childsettingname.md): Creates a setting or child setting for a flow.
- [Update custom settings associated with a flow](https://developer.conga.com/revenue/reference/put_flows-flowname-settings-settingname-childsettingname.md): Updates the following categories of setting associated with a flow name provided in the parameters. 
 <ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to update the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release.</p>
- [Retrieve custom settings associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-settings-settingname-childsettingname.md): Retrieves the following categories of setting associated with a flow name provided in the parameters. 
 <ul><li>Config Page Settings</li><li>Catalog Page Settings</li></ul><p>The above-mentioned settings are divided into the following custom settings or child settings which are used in the `settingName` parameter to retrieve the fields belonging to it.</p><ul><li>Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li></ul><p> The `childSettingName` is not supported in this release</p>
- [Delete settings](https://developer.conga.com/revenue/reference/delete_flows-flowname-settings-settingname-childsettingname-1.md): Deletes a setting or child setting for a flow.
- [Retrieve custom setting defined for a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-settings.md): Retrieves the custom settings defined for a flow name provided in the parameter. When custom settings are defined at both flow-level and global-level, flow-level take precedence over global settings in response the API retrieves.<p> The API retrieves the following custom settings: </p><ul><li> Config System Properties</li><li>Config Select Config Products Settings</li><li>Config Select Bundle Options Settings</li><li>Incentive System Properties</li><li>Installed Products Settings</li></ul><p>The above-mentioned custom settings are categorized into the following: </p><ul><li>Config Page Settings</li><li>Catalog Page Settings</li><li>Cart Page Settings</li><li>Pricing Engine</li><li>Configuration Engine</li><li>Promotions Settings</li><li>Asset Settings</li><li>Incentives Settings</li><li>Favorite Settings</li></ul>
- [Create views](https://developer.conga.com/revenue/reference/post_flows-flowname-views-1.md): Creates views for a flow.
- [Update flow views](https://developer.conga.com/revenue/reference/put_flows-flowname-views-1.md): Updates one or more views for a flow record.
- [Retrieve column displays associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-views-1.md): Retrieves the column displays for the flow passed in the parameter, based on the Display Column Settings configured and the Display Type. The columns are defined for the following <b>Display Types</b> which correspond to different sections on a CPQ page: 
 <ul><li>Cart Line Item</li><li>Cart Total Item</li><li>Mass Update</li><li>Cost Line Item</li><li>Usage Price tiers</li><li>Price Ramps</li><li>Tierd Price</li><li>Related Price</li><li>Line Item Waterfall</li><li>Option Line Item</li></ul><p>The API also retrieves the following details associated with the columns: </p><ul><li> Sequence: Defines sequence in which columns are displayed on CPQ pages.</li><li> Field Name: The name of the column</li><li> Is Editable: Indicates whether the column is editable in CPQ.</li><li>Style: Defines the column text alignment using CSS styles.</li><li> Style Class: Defines the style class used for the column.</li></ul>'
- [Retrieve views associated with a flow](https://developer.conga.com/revenue/reference/get_flows-flowname-views-viewname-1.md): Retrieves the views that are associated with the flow.
- [Delete flow views](https://developer.conga.com/revenue/reference/delete_flows-flowname-views-viewname-1.md): Deletes the views for a flow.
- [Retrieve deal color bands](https://developer.conga.com/revenue/reference/get_deal-guidance-color-bands-1.md): Retrieves  a list of color bands by deal guidance rule. Use query parameters to further narrow the results.
- [Create deal color bands](https://developer.conga.com/revenue/reference/post_deal-guidance-color-bands-1.md): Creates one or more color bands and assigns shapes and colors to them. You can use color bands to differentiate deals and define margins intelligently.
 
  Defining a color band is an initial, one-time action for an administrator setting up Deal Maximizer on the Conga Platform. Sales representatives will see appropriate bands before line items in the cart based on the defined rules. Though you can associate a shape to multiple colors. this not ideal, as it reduces distinctiveness between deals. You can create a maximum of 6 deal bands.
- [Update deal color bands](https://developer.conga.com/revenue/reference/patch_deal-guidance-color-bands-1.md): Updates specific fields on one or more color bands based on the details provided in the request body. It can update any field except the color band ID.
- [Delete deal color bands](https://developer.conga.com/revenue/reference/delete_deal-guidance-color-bands-1.md): Deletes one or more color bands based on the details provided in the request body.
- [Retrieve a deal color band](https://developer.conga.com/revenue/reference/get_deal-guidance-color-bands-id-1.md): Retrieves a single color band record based on the color band ID passed in the path parameter.
- [Update a deal color band](https://developer.conga.com/revenue/reference/patch_deal-guidance-color-bands-id-1.md): Updates specific fields on a single color band based on the color band ID passed in the path parameter.
- [Delete a deal color band](https://developer.conga.com/revenue/reference/delete_deal-guidance-color-bands-id-1.md): Deletes a color band record based on the color band ID passed in the path parameter.
- [Retrieve deal guidance dimension set members](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-parentid-dimensions-1.md): Retrieves the list of dimension set members.
- [Create deal guidance dimension set members](https://developer.conga.com/revenue/reference/post_deal-guidance-dimension-sets-parentid-dimensions-1.md): Creates the dimensions for a dimension set.
- [Update deal guidance dimension set members](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-parentid-dimensions-1.md): Updates dimension for a dimension set.
- [Delete deal guidance dimension set members](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-parentid-dimensions-1.md): Deletes dimension for a dimension set.
- [Retrieve a deal guidance dimension set member](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-parentid-dimensions-id-1.md): Retrieves a dimension record for a given dimension set.
- [Update a deal guidance dimension set member](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-parentid-dimensions-id-1.md): Updates a dimension record for a given dimension set.
- [Delete a deal guidance dimension set member](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-parentid-dimensions-id-1.md): Deletes a dimension record for a given dimension set.
- [Retrieve deal guidance dimension sets](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-1.md): Retrieves the list of the dimension sets for a pricing deal.
- [Create deal guidance dimension sets](https://developer.conga.com/revenue/reference/post_deal-guidance-dimension-sets-1.md): Creates the list of the dimension sets for a pricing deal.
- [Update deal guidance dimension sets](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-1.md): Updates the list of the dimension sets for a pricing deal.
- [Delete deal guidance dimension sets](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-1.md): Deletes the list of the dimension sets for a pricing deal.
- [Retrieve a deal guidance dimension set](https://developer.conga.com/revenue/reference/get_deal-guidance-dimension-sets-id-1.md): Retrieves a single dimension set record.
- [Update a deal guidance dimension set](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimension-sets-id-1.md): Updates one or more dimension set records based on the details provided in the request body.
- [Delete a deal guidance dimension set](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimension-sets-id-1.md): Deletes a single Deal Guidance Dimension Set by its identifier.
- [Retrieve deal guidance dimensions](https://developer.conga.com/revenue/reference/get_deal-guidance-dimensions-1.md): Retrieves a the list of dimensions.
- [Create deal guidance dimensions](https://developer.conga.com/revenue/reference/post_deal-guidance-dimensions-1.md): Creates one or more dimensions on a field so that you can set deal rule criteria based on the defined dimensions for a deal evaluation.
 
  After creating dimensions, create a dimension set and make use of the newly-created dimensions.
- [Update deal guidance dimensions](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimensions-1.md): Updates one or more dimensions based on the payload passed.
- [Delete deal guidance dimensions](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimensions-1.md): Deletes one or more dimensions based on the payload passed.
- [Retrieve a deal guidance dimension](https://developer.conga.com/revenue/reference/get_deal-guidance-dimensions-id-1.md): Retrieves a single deal guidance dimension by its identifier.
- [Update a deal guidance dimension](https://developer.conga.com/revenue/reference/patch_deal-guidance-dimensions-id-1.md): Updates the details of a dimension record.
- [Delete a deal guidance dimension](https://developer.conga.com/revenue/reference/delete_deal-guidance-dimensions-id-1.md): Deletes a details of a dimension record.
- [Retrieve deal guidance rule entries](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-parentid-entries-1.md): Retrieves the list of rules entries for deal guidance rules.
- [Create deal guidance rule entries](https://developer.conga.com/revenue/reference/post_deal-guidance-rules-parentid-entries-1.md): Creates one or more rule entries for a deal guidance rule.
- [Update deal guidance rule entries](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-parentid-entries-1.md): Update one or more rule entries for a deal guidance rule.
- [Delete deal guidance rule entries](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-parentid-entries-1.md): Delete one or more rule entries for a deal guidance rule.
- [Retrieve a deal guidance rule entry](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-parentid-entries-id-1.md): Retrieves a single rule entry for a deal guidance rule.
- [Update a deal guidance rule entry](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-parentid-entries-id-1.md): Updates a single rule entry for a deal guidance rule.
- [Delete a deal guidance rule entry](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-parentid-entries-id-1.md): Delete a single rule entry for a deal guidance rule.
- [Retrieve deal guidance rules](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-1.md): Retrieves the list of rules for a deal.
- [Create deal guidance rules](https://developer.conga.com/revenue/reference/post_deal-guidance-rules-1.md): Creates one or more deal guidance rules based on details provided in the request body.
- [Update deal guidance rules](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-1.md): Updates one or more deal guidance rules based on the details provided in the request body.
- [Delete deal guidance rules](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-1.md): Deletes one or more deal guidance rules based on the Ids provided in the request body.
- [Retrieve a deal guidance rule](https://developer.conga.com/revenue/reference/get_deal-guidance-rules-id-1.md): Retrieves a single deal guidance rule record.
- [Update a deal guidance rule](https://developer.conga.com/revenue/reference/patch_deal-guidance-rules-id-1.md): Updates a single deal guidance rule record.
- [Delete a deal guidance rule](https://developer.conga.com/revenue/reference/delete_deal-guidance-rules-id-1.md): Deletes a single deal guidance rule record.
- [Retrieve features](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-features-1.md): Retrieves a collection of features based on the parent feature set.
- [Create features](https://developer.conga.com/revenue/reference/post_feature-sets-parentid-features-1.md): Adds one or more features to the feature set collection. The parent feature set is automatically filled.
- [Update features](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-features-1.md): Updates one or more features in the feature set collection. Parent reassignment is not allowed.
- [Delete features](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-features-1.md): Deletes one or more features from the feature set collection.
- [Retrieve a feature](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-features-id-1.md): Retrieves a single feature document based on the identifier and parent feature set.
- [Update a feature](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-features-id-1.md): Updates a single feature document based on the identifier and parent feature set.
- [Delete a feature](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-features-id-1.md): Deletes a single feature document based on the identifier and parent feature set.
- [Retrieve feature sets](https://developer.conga.com/revenue/reference/get_feature-sets-1.md): Retrieves the collection of feature sets.
- [Create feature sets](https://developer.conga.com/revenue/reference/post_feature-sets-1.md): Creates multiple feature sets.
- [Update feature sets](https://developer.conga.com/revenue/reference/patch_feature-sets-1.md): Updates multiple feature sets.
- [Delete feature sets](https://developer.conga.com/revenue/reference/delete_feature-sets-1.md): Deletes multiple feature sets.
- [Retrieve a feature set](https://developer.conga.com/revenue/reference/get_feature-sets-id-1.md): Retrieves a single feature set by its identifier.
- [Update a feature set](https://developer.conga.com/revenue/reference/patch_feature-sets-id-1.md): Updates a single feature set.
- [Delete a feature set](https://developer.conga.com/revenue/reference/delete_feature-sets-id-1.md): Deletes a single feature set by its identifier.
- [Retrieve product features](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-product-features-1.md): Retrieves a list of junction records.
- [Create product features](https://developer.conga.com/revenue/reference/post_feature-sets-parentid-product-features-1.md): Creates multiple junction records.
- [Update product features](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-product-features-1.md): Updates multiple junction records.
- [Delete product features](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-product-features-1.md): Deletes multiple junction records.
- [Retrieve a product feature](https://developer.conga.com/revenue/reference/get_feature-sets-parentid-product-features-id-1.md): Retrieves a specific junction record.
- [Update a product feature](https://developer.conga.com/revenue/reference/patch_feature-sets-parentid-product-features-id-1.md): Updates a specific junction record.
- [Delete a product feature](https://developer.conga.com/revenue/reference/delete_feature-sets-parentid-product-features-id-1.md): Deletes a specific junction record.
- [Update hierarchies](https://developer.conga.com/revenue/reference/patch_hierarchies-1.md): Updates one or more hierarchy records.
- [Retrieve hierarchies](https://developer.conga.com/revenue/reference/get_hierarchies-1.md): Retrieves the hierarchy records.
- [Create hierarchies](https://developer.conga.com/revenue/reference/post_hierarchies-1.md): Creates one or more hierarchy records.
- [Delete hierarchies](https://developer.conga.com/revenue/reference/delete_hierarchies-1.md): Deletes  one or more hierarchy records.
- [Update a hierarchy](https://developer.conga.com/revenue/reference/patch_hierarchies-id-1.md): Updates a single hierarchy record.
- [Retrieve a hierarchy](https://developer.conga.com/revenue/reference/get_hierarchies-id-1.md): Retrieves a single hierarchy record.
- [Delete a hierarchy](https://developer.conga.com/revenue/reference/delete_hierarchies-id-1.md): Deletes a single hierarchy record.
- [Retrieve price list categories](https://developer.conga.com/revenue/reference/get_hierarchies-parentid-price-list-categories-1.md): Retrieve price list categories
- [Create price list categories](https://developer.conga.com/revenue/reference/post_hierarchies-parentid-price-list-categories-1.md): Create price list categories
- [Update price list categories](https://developer.conga.com/revenue/reference/patch_hierarchies-parentid-price-list-categories-1.md): Update price list categories
- [Delete price list categories](https://developer.conga.com/revenue/reference/delete_hierarchies-parentid-price-list-categories-1.md): Delete price list categories
- [Retrieve a price list category](https://developer.conga.com/revenue/reference/get_hierarchies-parentid-price-list-categories-id-1.md): Retrieve a price list category
- [Update a price list category](https://developer.conga.com/revenue/reference/patch_hierarchies-parentid-price-list-categories-id-1.md): Update a price list category
- [Delete a price list category](https://developer.conga.com/revenue/reference/delete_hierarchies-parentid-price-list-categories-id-1.md): Delete a price list category
- [Retrieve incentive coupons](https://developer.conga.com/revenue/reference/get_incentives-parentid-coupons-1.md): Retrieves a collection of incentive coupons based on the parent incentive.
- [Create incentive coupons](https://developer.conga.com/revenue/reference/post_incentives-parentid-coupons-1.md): Adds one or more incentive coupons to the collection. The parent incentive is automatically filled.
- [Update incentive coupons](https://developer.conga.com/revenue/reference/patch_incentives-parentid-coupons-1.md): Updates one or more incentive coupons in the collection. Parent reassignment is not allowed.
- [Delete incentive coupons](https://developer.conga.com/revenue/reference/delete_incentives-parentid-coupons-1.md): Deletes one or more incentive coupons from the collection.
- [Retrieve an incentive coupon](https://developer.conga.com/revenue/reference/get_incentives-parentid-coupons-id-1.md): Retrieves a single incentive coupon document based on the identifier and parent incentive.
- [Update an incentive coupon](https://developer.conga.com/revenue/reference/patch_incentives-parentid-coupons-id-1.md): Updates a single incentive coupon document based on the identifier and parent incentive.
- [Delete an incentive coupon](https://developer.conga.com/revenue/reference/delete_incentives-parentid-coupons-id-1.md): Deletes a single incentive coupon document based on the identifier and parent incentive.
- [Auto generates specified number of incentive coupons](https://developer.conga.com/revenue/reference/post_incentives-parentid-coupons-generate-numberofcoupons-1.md): Auto generates specified number of incentive coupons. The parent incentive is automatically filled.
- [Retrieve incentive limits](https://developer.conga.com/revenue/reference/get_incentives-parentid-limits-1.md): Retrieves a collection of incentive limits based on the parent incentive.
- [Create incentive limits](https://developer.conga.com/revenue/reference/post_incentives-parentid-limits-1.md): Adds one or more incentive limits to the collection. The parent incentive is automatically filled.
- [Update incentive limits](https://developer.conga.com/revenue/reference/patch_incentives-parentid-limits-1.md): Updates one or more incentive limits in the collection. Parent reassignment is not allowed.
- [Delete incentive limits](https://developer.conga.com/revenue/reference/delete_incentives-parentid-limits-1.md): Deletes one or more incentive limits from the collection.
- [Retrieve an incentive limit](https://developer.conga.com/revenue/reference/get_incentives-parentid-limits-id-1.md): Retrieves a single incentive limit document based on the identifier and parent incentive.
- [Update an incentive limit](https://developer.conga.com/revenue/reference/patch_incentives-parentid-limits-id-1.md): Updates a single incentive limit document based on the identifier and parent incentive.
- [Delete an incentive limit](https://developer.conga.com/revenue/reference/delete_incentives-parentid-limits-id-1.md): Deletes a single incentive limit document based on the identifier and parent incentive.
- [Retrieve incentive rule entries](https://developer.conga.com/revenue/reference/get_incentive-rules-parentid-entries-1.md): Retrieves a collection of incentive rule entries based on the parent incentive rule.
- [Create incentive rule entries](https://developer.conga.com/revenue/reference/post_incentive-rules-parentid-entries-1.md): Adds one or more incentive rule entries to the collection. The parent incentive rule is automatically filled.
- [Update incentive rule entries](https://developer.conga.com/revenue/reference/patch_incentive-rules-parentid-entries-1.md): Updates one or more incentive rule entries in the collection. Parent reassignment is not allowed.
- [Delete incentive rule entries](https://developer.conga.com/revenue/reference/delete_incentive-rules-parentid-entries-1.md): Deletes one or more incentive rule entries from the collection.
- [Retrieve an incentive rule entry](https://developer.conga.com/revenue/reference/get_incentive-rules-parentid-entries-id-1.md): Retrieves a single incentive rule entry document based on the identifier and parent incentive rule.
- [Update an incentive rule entry](https://developer.conga.com/revenue/reference/patch_incentive-rules-parentid-entries-id-1.md): Updates a single incentive rule entry document based on the identifier and parent incentive rule.
- [Delete an incentive rule entry](https://developer.conga.com/revenue/reference/delete_incentive-rules-parentid-entries-id-1.md): Deletes a single incentive rule entry document based on the identifier and parent incentive rule.
- [Retrieve incentive rules](https://developer.conga.com/revenue/reference/get_incentives-parentid-rules-1.md): Retrieves a collection of incentive rules based on the parent incentive.
- [Create incentive rules](https://developer.conga.com/revenue/reference/post_incentives-parentid-rules-1.md): Adds one or more incentive rules to the collection. The parent incentive is automatically filled.
- [Update incentive rules](https://developer.conga.com/revenue/reference/patch_incentives-parentid-rules-1.md): Updates one or more incentive rules in the collection. Parent reassignment is not allowed.
- [Delete incentive rules](https://developer.conga.com/revenue/reference/delete_incentives-parentid-rules-1.md): Deletes one or more incentive rules from the collection.
- [Retrieve an incentive rule](https://developer.conga.com/revenue/reference/get_incentives-parentid-rules-id-1.md): Retrieves a single incentive rule document based on the identifier and parent incentive.
- [Update an incentive rule](https://developer.conga.com/revenue/reference/patch_incentives-parentid-rules-id-1.md): Updates a single incentive rule document based on the identifier and parent incentive.
- [Delete an incentive rule](https://developer.conga.com/revenue/reference/delete_incentives-parentid-rules-id-1.md): Deletes a single incentive rule document based on the identifier and parent incentive.
- [Retrieve incentives](https://developer.conga.com/revenue/reference/get_incentives-1.md): Retrieves the collection of incentives.
- [Create incentives](https://developer.conga.com/revenue/reference/post_incentives-1.md): Creates multiple incentives.
- [Update incentives](https://developer.conga.com/revenue/reference/patch_incentives-1.md): Updates multiple incentives.
- [Delete incentives](https://developer.conga.com/revenue/reference/delete_incentives-1.md): Deletes multiple incentives.
- [Retrieve an incentive](https://developer.conga.com/revenue/reference/get_incentives-id-1.md): Retrieves a single incentive by its identifier.
- [Update an incentive](https://developer.conga.com/revenue/reference/patch_incentives-id-1.md): Updates a single incentive.
- [Delete an incentive](https://developer.conga.com/revenue/reference/delete_incentives-id-1.md): Deletes a single incentive by its identifier.
- [Retrieve lookup field settings](https://developer.conga.com/revenue/reference/get_lookupfield-settings-1.md): Retrieves the collection of lookup field settings.
- [Create lookup field settings](https://developer.conga.com/revenue/reference/post_lookupfield-settings-1.md): Creates multiple lookup field settings.
- [Update lookup field settings](https://developer.conga.com/revenue/reference/patch_lookupfield-settings-1.md): Updates multiple lookup field settings.
- [Delete lookup field settings](https://developer.conga.com/revenue/reference/delete_lookupfield-settings-1.md): Deletes multiple lookup field settings.
- [Retrieve a lookup field setting](https://developer.conga.com/revenue/reference/get_lookupfield-settings-id-1.md): Retrieves a single lookup field setting by its identifier.
- [Update a lookup field setting](https://developer.conga.com/revenue/reference/patch_lookupfield-settings-id-1.md): Updates a single lookup field setting.
- [Delete a lookup field setting](https://developer.conga.com/revenue/reference/delete_lookupfield-settings-id-1.md): Deletes a single lookup field setting by its identifier.
- [Get OpenSearchSyncAudit Records](https://developer.conga.com/revenue/reference/get_open-search-sync-audit-1.md): Retrieves OpenSearch synchronization audit records with optional filtering. Supports filtering by entity name, record IDs, and date range (start and end dates). Results are paginated with 500 records per page. Returns audit records that track synchronization events between the system and OpenSearch.
- [Retrieve option group members](https://developer.conga.com/revenue/reference/get_option-groups-parentid-products-1.md): Retrieves one or more products for an option group.
- [Create option group members](https://developer.conga.com/revenue/reference/post_option-groups-parentid-products-1.md): Creates one or more products to an option group by creating option group members.
- [Update option group members](https://developer.conga.com/revenue/reference/patch_option-groups-parentid-products-1.md): Updates one or more options associated with an option group. This API adds or removes options or updates option details in an option group.
- [Delete option group members](https://developer.conga.com/revenue/reference/delete_option-groups-parentid-products-1.md): Deletes one or more Products from an option group.
- [Retrieve an option group member](https://developer.conga.com/revenue/reference/get_option-groups-parentid-products-id-1.md): Retrieves a single product for an option group.
- [Update an option group member](https://developer.conga.com/revenue/reference/patch_option-groups-parentid-products-id-1.md): Updates a single product for an option group.
- [Delete an option group member](https://developer.conga.com/revenue/reference/delete_option-groups-parentid-products-id-1.md): Deletes a single product for an option group.
- [Retrieve an option group](https://developer.conga.com/revenue/reference/get_option-groups-id-1.md): Retrieves details of a single option group.
- [Delete an option group](https://developer.conga.com/revenue/reference/delete_option-groups-id-1.md): Deletes a single option group record.
- [Update an option group](https://developer.conga.com/revenue/reference/patch_option-groups-id-1.md): Updates a single option group record.
- [Create an option group clone](https://developer.conga.com/revenue/reference/post_option-groups-id-clone-1.md): Creates a clone of the Option Group with the specified identifier.
- [Retrieve option groups](https://developer.conga.com/revenue/reference/get_option-groups-1.md): Retrieves details of one or more option groups.
 
  The API returns the structure of each option group which includes the following details among others:<ul><li>option header fields</li><li>associated options</li><li>associated child option groups</li><li>Default Quantity</li><li>Min Quantity</li><li>Max Quantity</li></ul>
- [Update option groups](https://developer.conga.com/revenue/reference/patch_option-groups-1.md): Updates the details of one or more option groups based on the updates provided in the request body.
 
  The API returns the updated structure of the option group.
- [Delete option groups](https://developer.conga.com/revenue/reference/delete_option-groups-1.md): Deletes one or more option groups based on the list of option group IDs provided in the request body.
 
  The API deletes the options groups and all options and child option groups associated with them.
- [Create option groups](https://developer.conga.com/revenue/reference/post_option-groups-1.md): Creates one or more option groups based on the header details provided in the request body. 
 
  The API returns the structure of the newly created option groups.
- [Retrieve products](https://developer.conga.com/revenue/reference/get_option-groups-id-bundles-1.md): Retrieves list of products.
- [Retrieve parent option groups](https://developer.conga.com/revenue/reference/get_option-groups-id-parent-option-groups-1.md): Retrieves list of parent Option Groups.
- [Retrieve constraint rules](https://developer.conga.com/revenue/reference/get_option-groups-id-constraint-rules-1.md): Retrieves list of Constraint Rules.
- [Add an existing option group](https://developer.conga.com/revenue/reference/post_option-groups-optiongroup-add-1.md): Adds an existing option group as a child under the specified destination option group, creating a hierarchical relationship. The source option group must already exist in the system. Note: This API is deprecated. Use the bulk endpoint instead for adding one or more option groups.
- [Add multiple existing option groups under another option group](https://developer.conga.com/revenue/reference/post_option-groups-optiongroup-bulk.md): Add multiple existing Option Groups under given option group id.
- [Retrieve price dimensions](https://developer.conga.com/revenue/reference/get_price-dimensions-1.md): Retrieves all price dimensions. Use query parameters to further narrow the results.
  When executed, this API returns all price dimensions.
- [Create price dimensions](https://developer.conga.com/revenue/reference/post_price-dimensions-1.md): Creates one or more price dimensions.
 
  When executed, this API returns a unique price dimension ID (string) that CPQ automatically generates.
- [Update price dimensions](https://developer.conga.com/revenue/reference/patch_price-dimensions-1.md): Updates updates specific fields on one or more price dimensions. It can update any fields except price dimension ID.
 
  When executed, this API returns the updated price dimension or price dimensions.
- [Delete price dimensions](https://developer.conga.com/revenue/reference/delete_price-dimensions-1.md): Deletes one or more price dimensions. It can delete a maximum of 100 price dimensions.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a price dimension](https://developer.conga.com/revenue/reference/get_price-dimensions-id-1.md): Retrieves details of a price dimensions associated with the provided price dimensions ID.
- [Update a price dimension](https://developer.conga.com/revenue/reference/patch_price-dimensions-id-1.md): Updates a price dimension based on the details provided in the request body.
- [Delete a price dimension](https://developer.conga.com/revenue/reference/delete_price-dimensions-id-1.md): Deletes a price dimension based on the ID provided.
- [Fetch Datasource value](https://developer.conga.com/revenue/reference/get_price-dimensions-name-datasource-value-1.md): Fetch Datasource value
- [Retrieve price lists](https://developer.conga.com/revenue/reference/get_price-lists-1.md): Retrieves all price lists, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns all price lists.
- [Create price lists](https://developer.conga.com/revenue/reference/post_price-lists-1.md): Creates one or more price lists. It can create a maximum of 100 price lists. To create multiple price lists, pass one array for each price list record in the API request.
 
  The selling organization can have one price list as the master price list, which will have price list items for all products it sells. The other price lists are based on the master price list with currency conversion and PLI overrides in some cases. The selling organization can have contract prices that are negotiated with customers. You can create a contract price list for each negotiated contract and PLIs for each product that has prices contracted. When executed, this API returns a unique price list ID (string) that CPQ automatically generates.
- [Update price lists](https://developer.conga.com/revenue/reference/patch_price-lists-1.md): Updates specific fields on one or more price lists. It can update any field except the price list ID.
 
  When executed, this API returns the updated price list or price lists.
- [Delete price lists](https://developer.conga.com/revenue/reference/delete_price-lists-1.md): Deletes one or more price lists. Permissions are required to delete price lists.
 
  When executed, this API returns one or more records with each record ID's delete status.
- [Retrieve a price list](https://developer.conga.com/revenue/reference/get_price-lists-id-1.md): Retrieves a  price list based on the price list ID passed in the path parameter.
 
  When executed, this API returns a specific price list with its details.
- [Update a price list](https://developer.conga.com/revenue/reference/patch_price-lists-id-1.md): Updates a specific fields on a price list based on the price list ID passed in the path parameter.
 
  When executed, this API returns the updated price list.
- [Delete a price list](https://developer.conga.com/revenue/reference/delete_price-lists-id-1.md): Deletes a price list based on the price list ID passed in the path parameter. Permissions are required to delete a price list.
 
  When executed, this API returns a record with the delete status of the associated record ID.
- [Get category records](https://developer.conga.com/revenue/reference/get_price-lists-pricelistid-categories-1.md): Returns category records for a given price list. Your request can set
 the number of records returned per page and the total number of pages.
- [Retrieve price list categories](https://developer.conga.com/revenue/reference/get_price-lists-parentid-price-list-categories-1.md): Retrieve price list categories
- [Create price list categories](https://developer.conga.com/revenue/reference/post_price-lists-parentid-price-list-categories-1.md): Create price list categories
- [Update price list categories](https://developer.conga.com/revenue/reference/patch_price-lists-parentid-price-list-categories-1.md): Update price list categories
- [Delete price list categories](https://developer.conga.com/revenue/reference/delete_price-lists-parentid-price-list-categories-1.md): Delete price list categories
- [Retrieve a price list category](https://developer.conga.com/revenue/reference/get_price-lists-parentid-price-list-categories-id-1.md): Retrieve a price list category
- [Update a price list category](https://developer.conga.com/revenue/reference/patch_price-lists-parentid-price-list-categories-id-1.md): Update a price list category
- [Delete a price list category](https://developer.conga.com/revenue/reference/delete_price-lists-parentid-price-list-categories-id-1.md): Delete a price list category
- [Retrieve price list items](https://developer.conga.com/revenue/reference/get_price-lists-parentid-price-list-items-1.md): Retrieves all price list items in a price list, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns all price list items in a price list.
- [Create price list items](https://developer.conga.com/revenue/reference/post_price-lists-parentid-price-list-items-1.md): creates one or more price list items in a specific price list. It can create a maximum of 1000 price list items. It can create multiple price list items for the same product or multiple products. To create multiple price list items, pass one array for each price list item record in the API request.
 
  When executed, this API returns a unique price list item ID (string) that CPQ automatically generates.
- [Update price list items](https://developer.conga.com/revenue/reference/patch_price-lists-parentid-price-list-items-1.md): Updates specific fields on one or more price list items. It can update any field except the price list item ID.
 
  When executed, this API returns the updated price list item or items.
- [Delete price list items](https://developer.conga.com/revenue/reference/delete_price-lists-parentid-price-list-items-1.md): Delete price list items
- [Retrieve a price list item](https://developer.conga.com/revenue/reference/get_price-lists-parentid-price-list-items-id-1.md): Retrieves a price list item in a price list, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns a price list item in a price list.
- [Update a price list item](https://developer.conga.com/revenue/reference/patch_price-lists-parentid-price-list-items-id-1.md): Updates specific fields on specified price list item. It can update any field except the price list item ID.
 
  When executed, this API returns the updated price list item.
- [Delete a price list item](https://developer.conga.com/revenue/reference/delete_price-lists-parentid-price-list-items-id-1.md): Deletes a specified price list item in a price list.
 
  When executed, this API returns the delete status of associated record ID.
- [Retrieve lookup records for price list](https://developer.conga.com/revenue/reference/get_price-lists-id-products-1.md): Retrieves the lookup records for a specific price list based on the identifier.
- [Clone a price list item](https://developer.conga.com/revenue/reference/post_price-lists-parentid-price-list-items-id-clone-1.md): Clones a price list item.
- [Retrieve price matrices](https://developer.conga.com/revenue/reference/get_matrices-1.md): Retrieves all price matrices, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns all price matrices.
- [Create price matrices](https://developer.conga.com/revenue/reference/post_matrices-1.md): Creates one or more price matrices for the same or different price list items. It can create a maximum of 1000 price matrices. To create multiple price matrices, pass one array for each price matrix record in the API request.
 
  When executed, this API returns a unique price matrix ID (string) that CPQ automatically generates.
- [Update price matrices](https://developer.conga.com/revenue/reference/patch_matrices-1.md): Updates specific fields on one or more price matrices. It can update any field except price matrix ID.
 
  When executed, this API returns the updated price matrix or price matrices.
- [Delete price matrices](https://developer.conga.com/revenue/reference/delete_matrices-1.md): Deletes one or more price matrices. It can delete a maximum of 100 price matrices.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a price matrix](https://developer.conga.com/revenue/reference/get_matrices-id-1.md): Retrieves details of a matrix associated with the provided matrix ID.
- [Update a price matrix](https://developer.conga.com/revenue/reference/patch_matrices-id-1.md): Updates a matrix based on the details provided in the request body for a specified matrix.
- [Delete a price matrix](https://developer.conga.com/revenue/reference/delete_matrices-id-1.md): Deletes a matrix based on the ID provided.
- [Retrieve price matrix entries](https://developer.conga.com/revenue/reference/get_matrices-parentid-matrix-entries-1.md): Retrieves all price matrix entries for a specific price matrix. Use query parameters to further narrow the results.
 
  When executed, this API returns all price matrix entries for a specific price matrix.
- [Create price matrix entries](https://developer.conga.com/revenue/reference/post_matrices-parentid-matrix-entries-1.md): Creates one or more price matrix entries. It can create a maximum of 1000 price matrix entries.
 
  When executed, this API returns a unique price matrix entry ID (string) that CPQ automatically generates.
- [Update price matrix entries](https://developer.conga.com/revenue/reference/patch_matrices-parentid-matrix-entries-1.md): Updates specific fields on one or more price matrix entries. It can update any fields except price matrix entry ID.
 
  When executed successfully, this API returns the updated price matrix entry or price matrix entries.
- [Delete price matrix entries](https://developer.conga.com/revenue/reference/delete_matrices-parentid-matrix-entries-1.md): Deletes one or more price matrix entries. It can delete a maximum of 100 price matrix entries.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a price matrix entry](https://developer.conga.com/revenue/reference/get_matrices-parentid-matrix-entries-id-1.md): Retrieves a price matrix entry for a specified price matrix entry for a specific price matrix. Use query parameters to further narrow the results.
  When executed, this API returns a price matrix entry for specified Id for a specific price matrix.
- [Update a price matrix entry](https://developer.conga.com/revenue/reference/patch_matrices-parentid-matrix-entries-id-1.md): Updates specific fields on specified price matrix entry. It can update any fields except price matrix entry ID.
 
  When executed successfully, this API returns the updated price matrix entry.
- [Delete a price matrix entry](https://developer.conga.com/revenue/reference/delete_matrices-parentid-matrix-entries-id-1.md): Deletes a specified price matrix entry.
 
  When executed, this API returns the delete status for specified record ID.
- [Retrieve price rule entries](https://developer.conga.com/revenue/reference/get_rules-parentid-rule-entries-1.md): Retrieves all price rule entries in a price rule, with their details. Use query parameters to further narrow down the retrieved results.
 
  When executed, this API returns all price rule entries in a price rule.
- [Create price rule entries](https://developer.conga.com/revenue/reference/post_rules-parentid-rule-entries-1.md): Ccreates one or more price rule entries. It can create a maximum of 100 price rule entries for a particular price rule.
 
  When executed, this API returns a unique price rule entry ID (string) that CPQ automatically generates.
- [Update price rule entries](https://developer.conga.com/revenue/reference/patch_rules-parentid-rule-entries-1.md): Updates specific fields on one or more price rule entries. It can update any fields except price rule entry ID.
 
  When executed, this API returns the updated price rule entry or price rule entries.
- [Delete price rule entries](https://developer.conga.com/revenue/reference/delete_rules-parentid-rule-entries-1.md): Deletes one or more price rule entries from a specific price rule of type condition or dimension.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a price rule entry](https://developer.conga.com/revenue/reference/get_rules-parentid-rule-entries-id-1.md): Retrieves a single price rule entry document based on the identifier and parent price rule.
- [Update a price rule entry](https://developer.conga.com/revenue/reference/patch_rules-parentid-rule-entries-id-1.md): Updates a single price rule entry document based on the identifier and parent price rule.
- [Delete a price rule entry](https://developer.conga.com/revenue/reference/delete_rules-parentid-rule-entries-id-1.md): Deletes a single price rule entry document based on the identifier and parent price rule.
- [Retrieve price rule sets](https://developer.conga.com/revenue/reference/get_rule-sets-1.md): Retrieves all price rule sets, with their details. Use query parameters to further narrow down the retrieved results.
 
  When executed, this API returns all price rule sets.
- [Create price rule sets](https://developer.conga.com/revenue/reference/post_rule-sets-1.md): Creates one or more price rule sets.
 
  When executed, this API returns a unique price rule set ID (string) that CPQ automatically generates.
- [Update price rule sets](https://developer.conga.com/revenue/reference/patch_rule-sets-1.md): Updates specific fields on one or more price rule sets. It can update any fields except price rule set ID.
 
  When executed, this API returns the updated price rule set or price rule sets.
- [Delete price rule sets](https://developer.conga.com/revenue/reference/delete_rule-sets-1.md): Deletes one or more price rule sets. It can delete a maximum of 100 price rule sets. When you delete a price rule set, CPQ deletes its related price rules and price rules entries.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a price rule set](https://developer.conga.com/revenue/reference/get_rule-sets-id-1.md): Retrieves a single price rule set by its identifier.
- [Update a price rule set](https://developer.conga.com/revenue/reference/patch_rule-sets-id-1.md): Updates a single price rule set.
- [Delete a price rule set](https://developer.conga.com/revenue/reference/delete_rule-sets-id-1.md): Deletes a single price rule set by its identifier.
- [Retrieve price rules](https://developer.conga.com/revenue/reference/get_rule-sets-parentid-rules-1.md): Retrieves all price rules in a price rule set, with their details. Use query parameters to further narrow down the retrieved results.
 
  When executed, this API returns all price rules in a price rule set.
- [Create price rules](https://developer.conga.com/revenue/reference/post_rule-sets-parentid-rules-1.md): Creates one or more price rules for a specific price rule set.
 
  When executed, this API returns a unique price rule ID (string) that CPQ automatically generates.
- [Update price rules](https://developer.conga.com/revenue/reference/patch_rule-sets-parentid-rules-1.md): Updates specific fields on one or more price rules. It can update any fields except price rule ID.
 
  When executed, this API returns the updated price rule or price rules.
- [Delete price rules](https://developer.conga.com/revenue/reference/delete_rule-sets-parentid-rules-1.md): Deletes  one or more price rules from a price rule set. It can delete a maximum of 100 price rules. When you delete a price rule, CPQ deletes its related price rule entries.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a price rule](https://developer.conga.com/revenue/reference/get_rule-sets-parentid-rules-id-1.md): Retrieves a single price rule document based on the identifier and parent price ruleset.
- [Update a price rule](https://developer.conga.com/revenue/reference/patch_rule-sets-parentid-rules-id-1.md): Updates a single price rule document based on the identifier and parent price ruleset.
- [Delete a price rule](https://developer.conga.com/revenue/reference/delete_rule-sets-parentid-rules-id-1.md): Deletes a single price rule document based on the identifier and parent price ruleset.
- [Retrieve price escalators](https://developer.conga.com/revenue/reference/get_price-list-items-parentid-price-escalators-1.md): Retrieves a collection of price escalators based on the parent price list item.
- [Create price escalators](https://developer.conga.com/revenue/reference/post_price-list-items-parentid-price-escalators-1.md): Adds one or more price escalators to the collection. The parent price list item is automatically filled.
- [Update price escalators](https://developer.conga.com/revenue/reference/patch_price-list-items-parentid-price-escalators-1.md): Updates one or more price escalators in the collection. Parent reassignment is not allowed.
- [Delete price escalators](https://developer.conga.com/revenue/reference/delete_price-list-items-parentid-price-escalators-1.md): Deletes one or more price escalators from the collection.
- [Retrieve a price escalator](https://developer.conga.com/revenue/reference/get_price-list-items-parentid-price-escalators-id-1.md): Retrieves a single price escalator document based on the identifier and parent price list item.
- [Update a price escalator](https://developer.conga.com/revenue/reference/patch_price-list-items-parentid-price-escalators-id-1.md): Updates a single price escalator document based on the identifier and parent price list item.
- [Delete a price escalator](https://developer.conga.com/revenue/reference/delete_price-list-items-parentid-price-escalators-id-1.md): Deletes a single price escalator document based on the identifier and parent price list item.
- [Retrieve price list items](https://developer.conga.com/revenue/reference/get_products-parentid-price-list-items-1.md): Retrieves all price list items in a price list, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns all price list items in a price list.
- [Create price list items](https://developer.conga.com/revenue/reference/post_products-parentid-price-list-items-1.md): creates one or more price list items in a specific price list. It can create a maximum of 1000 price list items. It can create multiple price list items for the same product or multiple products. To create multiple price list items, pass one array for each price list item record in the API request.
 
  When executed, this API returns a unique price list item ID (string) that CPQ automatically generates.
- [Update price list items](https://developer.conga.com/revenue/reference/patch_products-parentid-price-list-items-1.md): Updates specific fields on one or more price list items. It can update any field except the price list item ID.
 
  When executed, this API returns the updated price list item or items.
- [Delete price list items](https://developer.conga.com/revenue/reference/delete_products-parentid-price-list-items-1.md): Delete price list items
- [Retrieve a price list item](https://developer.conga.com/revenue/reference/get_products-parentid-price-list-items-id-1.md): Retrieves a price list item in a price list, with their details. Use query parameters to further narrow the results.
 
  When executed, this API returns a price list item in a price list.
- [Update a price list item](https://developer.conga.com/revenue/reference/patch_products-parentid-price-list-items-id-1.md): Updates specific fields on specified price list item. It can update any field except the price list item ID.
 
  When executed, this API returns the updated price list item.
- [Delete a price list item](https://developer.conga.com/revenue/reference/delete_products-parentid-price-list-items-id-1.md): Deletes a specified price list item in a price list.
 
  When executed, this API returns the delete status of associated record ID.
- [Retrieve Price Lists](https://developer.conga.com/revenue/reference/get_products-id-price-lists-1.md): Retrieves price lists for a specific product.
- [Clone a price list item](https://developer.conga.com/revenue/reference/post_products-parentid-price-list-items-id-clone-1.md): Clones a price list item.
- [Get product attributes](https://developer.conga.com/revenue/reference/get_products-productid-attributes-1.md): Gets attributes for the named product
- [Retrive lookup records](https://developer.conga.com/revenue/reference/get_products-id-categories-1.md): Retrieves the lookup records for a given ID.
- [Retrieve product categories](https://developer.conga.com/revenue/reference/get_products-parentid-product-categories-1.md): Retrieves the product category records for a category.
- [Create product categories](https://developer.conga.com/revenue/reference/post_products-parentid-product-categories-1.md): Creates multiple product categories.
- [Update product categories](https://developer.conga.com/revenue/reference/patch_products-parentid-product-categories-1.md): Updates multiple product categories.
- [Delete product categories](https://developer.conga.com/revenue/reference/delete_products-parentid-product-categories-1.md): Deletes one or more product categories from a specified product based on the parameters and request body.
- [Retrieve a product category](https://developer.conga.com/revenue/reference/get_products-parentid-product-categories-id-1.md): Retrieves a product category by ID.
- [Update a product category](https://developer.conga.com/revenue/reference/patch_products-parentid-product-categories-id-1.md): Updates a product category.
- [Delete a product category](https://developer.conga.com/revenue/reference/delete_products-parentid-product-categories-id-1.md): Deletes a product category by ID.
- [Retrieve product features](https://developer.conga.com/revenue/reference/get_products-parentid-product-features-1.md): Retrieves a list of junction records.
- [Create product features](https://developer.conga.com/revenue/reference/post_products-parentid-product-features-1.md): Creates multiple junction records.
- [Update product features](https://developer.conga.com/revenue/reference/patch_products-parentid-product-features-1.md): Updates multiple junction records.
- [Delete product features](https://developer.conga.com/revenue/reference/delete_products-parentid-product-features-1.md): Deletes multiple junction records.
- [Retrieve a product feature](https://developer.conga.com/revenue/reference/get_products-parentid-product-features-id-1.md): Retrieves a specific junction record.
- [Update a product feature](https://developer.conga.com/revenue/reference/patch_products-parentid-product-features-id-1.md): Updates a specific junction record.
- [Delete a product feature](https://developer.conga.com/revenue/reference/delete_products-parentid-product-features-id-1.md): Deletes a specific junction record.
- [Retrieve product feature values](https://developer.conga.com/revenue/reference/get_products-parentid-product-feature-values-1.md): Retrieves a list of junction records.
- [Create product feature values](https://developer.conga.com/revenue/reference/post_products-parentid-product-feature-values-1.md): Creates multiple junction records.
- [Update product feature values](https://developer.conga.com/revenue/reference/patch_products-parentid-product-feature-values-1.md): Updates multiple junction records.
- [Delete product feature values](https://developer.conga.com/revenue/reference/delete_products-parentid-product-feature-values-1.md): Deletes multiple junction records.
- [Retrieve a product feature value](https://developer.conga.com/revenue/reference/get_products-parentid-product-feature-values-id-1.md): Retrieves a specific junction record.
- [Update a product feature value](https://developer.conga.com/revenue/reference/patch_products-parentid-product-feature-values-id-1.md): Updates a specific junction record.
- [Delete a product feature value](https://developer.conga.com/revenue/reference/delete_products-parentid-product-feature-values-id-1.md): Deletes a specific product feature value junction record that links a product to a feature. This removes the association between the product and feature while preserving both the product and feature entities themselves.
- [Retrieve a product group members list](https://developer.conga.com/revenue/reference/get_products-parentid-product-group-members-1.md): Retrieves a product group member for a product.
- [Create product group members](https://developer.conga.com/revenue/reference/post_products-parentid-product-group-members-1.md): Creates one or more product group members with product based on the product ID provided in the parameters and a list of product group members provided in the request body.
- [Update product group members](https://developer.conga.com/revenue/reference/patch_products-parentid-product-group-members-1.md): Updates one or more product group members associated with a specified product based on the field updates provided in the request body. The API returns the updated structure of the product group members.
- [Delete product group members](https://developer.conga.com/revenue/reference/delete_products-parentid-product-group-members-1.md): Deletes one or more product group members from a specified product based on the parameters and request body.
- [Retrieve a product group member](https://developer.conga.com/revenue/reference/get_products-parentid-product-group-members-id-1.md): Retrieve a product group member
- [Update a product group member](https://developer.conga.com/revenue/reference/patch_products-parentid-product-group-members-id-1.md): Updates a product group member for a given product.
- [Delete a product group member](https://developer.conga.com/revenue/reference/delete_products-parentid-product-group-members-id-1.md): Deletes a product group member from a product.
- [Retrieve product groups for a specific product](https://developer.conga.com/revenue/reference/get_products-id-product-groups-1.md): Retrieves product groups for a specific product.
- [Retrieve all constraint rules](https://developer.conga.com/revenue/reference/get_products-id-constraint-rules-1.md): Retrieves all constraint rules with their details. Use query parameters to further narrow the results.
 <p>When executed, this API returns all constraint rules.</p>
- [Retrieve all attribute rules](https://developer.conga.com/revenue/reference/get_products-id-attribute-rules-1.md): Retrieves all attributes rules in the system.
- [List Attributes](https://developer.conga.com/revenue/reference/get_products-id-attribute-matrices-1.md): Retrieves the attribute collection.
- [Retrieve the collection of products](https://developer.conga.com/revenue/reference/get_products-2.md): Retrieves the collection of all the products.
- [Create multiple products](https://developer.conga.com/revenue/reference/post_products-1.md): Creates multiple product.
- [Update multiple products](https://developer.conga.com/revenue/reference/patch_products-1.md): Updates multiple products.
- [Delete multiple products](https://developer.conga.com/revenue/reference/delete_products-1.md): Deletes multiple products.
- [Retrieve a single product by its identifier](https://developer.conga.com/revenue/reference/get_products-id-1.md): Retrieves a single product by its identifier.
- [Update a single product](https://developer.conga.com/revenue/reference/patch_products-id-1.md): Updates a single product.
- [Delete a single product by its identifier](https://developer.conga.com/revenue/reference/delete_products-id-1.md): Deletes a single product by its identifier.
- [Clone a product](https://developer.conga.com/revenue/reference/post_products-id-clone-1.md): Clones a product.
- [Retrieve product attribute groups](https://developer.conga.com/revenue/reference/get_products-parentid-attribute-groups-1.md): Retrieves the attribute groups for a given product.
- [Create product attribute groups](https://developer.conga.com/revenue/reference/post_products-parentid-attribute-groups-1.md): Creates one or more attribute groups to a product. The product can be standalone, bundle or an option.
- [Update product attribute groups](https://developer.conga.com/revenue/reference/patch_products-parentid-attribute-groups-1.md): Updates one or more product attribute groups.
- [Delete product attribute groups](https://developer.conga.com/revenue/reference/delete_products-parentid-attribute-groups-1.md): Deletes one or more attribute groups associated with the product ID provided in the parameter. The product can be standalone, bundle or an option.
- [Retrieve a product attribute group](https://developer.conga.com/revenue/reference/get_products-parentid-attribute-groups-id-1.md): Retrieves a single product attribute group document based on the identifier and parent product.
- [Update a product attribute group](https://developer.conga.com/revenue/reference/patch_products-parentid-attribute-groups-id-1.md): Updates a single product attribute group document based on the identifier and parent product.
- [Delete a product attribute group](https://developer.conga.com/revenue/reference/delete_products-parentid-attribute-groups-id-1.md): Deletes a single product attribute group document based on the identifier and parent product.
- [Retrieve product attribute rule actions](https://developer.conga.com/revenue/reference/get_attribute-rules-parentid-actions-1.md): Retrieves the attribute rule actions.
- [Create product attribute rule actions](https://developer.conga.com/revenue/reference/post_attribute-rules-parentid-actions-1.md): Creates one or more attribute rule actions for a given attribute rule ID.
- [Update product attribute rule actions](https://developer.conga.com/revenue/reference/patch_attribute-rules-parentid-actions-1.md): Updates one or more attribute rule actions for a given attribute rule ID.
- [Delete product attribute rule actions](https://developer.conga.com/revenue/reference/delete_attribute-rules-parentid-actions-1.md): Deletes one or more attribute rule actions.
- [Retrieve a product attribute rule action](https://developer.conga.com/revenue/reference/get_attribute-rules-parentid-actions-id-1.md): Retrieves a single product attribute rule action for a specific product attribute rule.
- [Update a product attribute rule action](https://developer.conga.com/revenue/reference/patch_attribute-rules-parentid-actions-id-1.md): Updates a single product attribute rule action based on the identifier for a specific Product Attribute Rule.
- [Delete a product attribute rule action](https://developer.conga.com/revenue/reference/delete_attribute-rules-parentid-actions-id-1.md): Deletes a single product attribute rule action for a specific Product Attribute Rule.
- [Retrieve product attribute rules](https://developer.conga.com/revenue/reference/get_attribute-rules-1.md): Retrieves all attributes rules in the system.
- [Create product attribute rules](https://developer.conga.com/revenue/reference/post_attribute-rules-1.md): Creates one or more attribute rules along with attribute rule condition for each attribute rule, based on the details provided in the request body.
 
  Each attribute rule can have only one attribute rule condition. The attribute rule condition can be defined using product scope or condition criteria. When executed, the API returns the structure of the attribute rule.
- [Update product attribute rules](https://developer.conga.com/revenue/reference/patch_attribute-rules-1.md): Updates one or more attribute rules the attribute rule conditions based on the details.
- [Delete product attribute rules](https://developer.conga.com/revenue/reference/delete_attribute-rules-1.md): Deletes one or more attribute rules based on the input in request body.
- [Retrieve a product attribute rule](https://developer.conga.com/revenue/reference/get_attribute-rules-id-1.md): Retrieves a single product attribute rule based on the identifier.
- [Update a product attribute rule](https://developer.conga.com/revenue/reference/patch_attribute-rules-id-1.md): Updates a single product attribute rule based on the identifier.
- [Delete a product attribute rule](https://developer.conga.com/revenue/reference/delete_attribute-rules-id-1.md): Deletes a single product attribute rule.
- [Retrieve product groups](https://developer.conga.com/revenue/reference/get_product-groups-1.md): Retrieves list of product groups for a given product.
- [Create product groups](https://developer.conga.com/revenue/reference/post_product-groups-1.md): Creates one or more product groups with details provided in the request body. The API returns the IDs of the newly created product groups and their structure.
- [Update product groups](https://developer.conga.com/revenue/reference/patch_product-groups-1.md): Updates one or more product groups.
- [Delete product groups](https://developer.conga.com/revenue/reference/delete_product-groups-1.md): Deletes one or more product group records.
- [Retrieve a product group](https://developer.conga.com/revenue/reference/get_product-groups-id-1.md): Retrieves the details of a product group based on the product group ID provided in the parameters.
 
  The API returns the details of product group object, the fields mentioned in the parameters, and the products associated with the product group.
- [Update a product group](https://developer.conga.com/revenue/reference/patch_product-groups-id-1.md): Updatesthe product group with details provided in the request parameter. The API returns the ID of the updated product group and its structure.
- [Delete a product group](https://developer.conga.com/revenue/reference/delete_product-groups-id-1.md): Deletes the product group where the product group ID matches the ID provided in the parameter.
- [Retrieve constraint rule records](https://developer.conga.com/revenue/reference/get_product-groups-id-constraint-rules-1.md): Retrieves the constraint rule records for a product group.
- [Retrieve attribute rule records](https://developer.conga.com/revenue/reference/get_product-groups-id-attribute-rules-1.md): Retrieves the attribute rule records for a product group.
- [Retrieve attribute matrix records](https://developer.conga.com/revenue/reference/get_product-groups-id-attribute-matrices-1.md): Retrieves the attribute matrix records for a product group.
- [Retrieve a product group members list](https://developer.conga.com/revenue/reference/get_product-groups-parentid-product-group-members-1.md): Retrieves a product group member for a product.
- [Create product group members](https://developer.conga.com/revenue/reference/post_product-groups-parentid-product-group-members-1.md): Creates one or more product group members with product based on the product ID provided in the parameters and a list of product group members provided in the request body.
- [Update product group members](https://developer.conga.com/revenue/reference/patch_product-groups-parentid-product-group-members-1.md): Updates one or more product group members associated with a specified product based on the field updates provided in the request body. The API returns the updated structure of the product group members.
- [Delete product group members](https://developer.conga.com/revenue/reference/delete_product-groups-parentid-product-group-members-1.md): Deletes one or more product group members from a specified product based on the parameters and request body.
- [Retrieve a product group member](https://developer.conga.com/revenue/reference/get_product-groups-parentid-product-group-members-id-1.md): Retrieve a product group member
- [Update a product group member](https://developer.conga.com/revenue/reference/patch_product-groups-parentid-product-group-members-id-1.md): Updates a product group member for a given product.
- [Delete a product group member](https://developer.conga.com/revenue/reference/delete_product-groups-parentid-product-group-members-id-1.md): Deletes a product group member from a product.
- [Retrieve products for a specific product group.](https://developer.conga.com/revenue/reference/get_product-groups-id-products-1.md): Retrieves product for a specific product group.
- [Retrieve a product information document](https://developer.conga.com/revenue/reference/get_products-parentid-information-1.md): Retrieves product information document with their details. Use query parameters to further narrow down the retrieved results.
- [Create product information document](https://developer.conga.com/revenue/reference/post_products-parentid-information-1.md): Creates one or more product information for a specific product.
- [Update product information documents](https://developer.conga.com/revenue/reference/patch_products-parentid-information-1.md): Updates specific fields on one or more product information documents under a given product.
- [Delete product information](https://developer.conga.com/revenue/reference/delete_products-parentid-information-1.md): Deletes one or more product information document under a product.
- [Retrieve a single product information document](https://developer.conga.com/revenue/reference/get_products-parentid-information-id-1.md): Retrieves a single product information document based on the identifier and parent product.
- [Update a product information document](https://developer.conga.com/revenue/reference/patch_products-parentid-information-id-1.md): Updates a single product information document based on the identifier and parent product.
- [Delete a product information document](https://developer.conga.com/revenue/reference/delete_products-parentid-information-id-1.md): Deletes a single product information document based on the identifier and parent product.
- [Retrieve product option components](https://developer.conga.com/revenue/reference/get_product-option-group-parentid-products-1.md): Retrieves a list of all option groups and options associated with the bundle product ID provided in parameters. The options associated with the sub-bundle of the given product are not retrieved.
- [Create product option components](https://developer.conga.com/revenue/reference/post_product-option-group-parentid-products-1.md): Creates one or more standalone products and bundles to a bundle. Also adds options to an option group that is already associated with the bundle.
- [Update product option components](https://developer.conga.com/revenue/reference/patch_product-option-group-parentid-products-1.md): Updates one or more product option components.
- [Delete product option components](https://developer.conga.com/revenue/reference/delete_product-option-group-parentid-products-1.md): Deletes products from a bundle or removes options from an option group associated with the bundle.
- [Retrieve product option component](https://developer.conga.com/revenue/reference/get_product-option-group-parentid-products-id-1.md): Retrieves a single product option component document based on the identifier and parent product option group.
- [Update a product option component](https://developer.conga.com/revenue/reference/patch_product-option-group-parentid-products-id-1.md): Updates a single product option component document based on the identifier and parent product option group.
- [Delete product option component](https://developer.conga.com/revenue/reference/delete_product-option-group-parentid-products-id-1.md): Deletes a single product option component document based on the identifier and parent product option group.
- [Retrieve product option prices](https://developer.conga.com/revenue/reference/get_product-option-prices-1.md): Retrieves the collection of product option prices.
- [Create product option prices](https://developer.conga.com/revenue/reference/post_product-option-prices-1.md): Creates multiple product option prices.
- [Update product option prices](https://developer.conga.com/revenue/reference/patch_product-option-prices-1.md): Updates multiple product option prices.
- [Delete product option prices](https://developer.conga.com/revenue/reference/delete_product-option-prices-1.md): Deletes multiple product option prices.
- [Retrieve a product option price](https://developer.conga.com/revenue/reference/get_product-option-prices-id-1.md): Retrieves a single product option price by its identifier.
- [Update a product option price](https://developer.conga.com/revenue/reference/patch_product-option-prices-id-1.md): Updates a single product option price.
- [Delete a product option price](https://developer.conga.com/revenue/reference/delete_product-option-prices-id-1.md): Deletes a single product option price by its identifier.
- [Retrieve product feature values](https://developer.conga.com/revenue/reference/get_features-parentid-product-feature-values-1.md): Retrieves a list of junction records.
- [Create product feature values](https://developer.conga.com/revenue/reference/post_features-parentid-product-feature-values-1.md): Creates multiple junction records.
- [Update product feature values](https://developer.conga.com/revenue/reference/patch_features-parentid-product-feature-values-1.md): Updates multiple junction records.
- [Delete product feature values](https://developer.conga.com/revenue/reference/delete_features-parentid-product-feature-values-1.md): Deletes multiple junction records.
- [Retrieve a product feature value](https://developer.conga.com/revenue/reference/get_features-parentid-product-feature-values-id-1.md): Retrieves a specific junction record.
- [Update a product feature value](https://developer.conga.com/revenue/reference/patch_features-parentid-product-feature-values-id-1.md): Updates a specific junction record.
- [Delete a product feature value](https://developer.conga.com/revenue/reference/delete_features-parentid-product-feature-values-id-1.md): Deletes a specific product feature value junction record that links a product to a feature. This removes the association between the product and feature while preserving both the product and feature entities themselves.
- [Retrieve a product option group](https://developer.conga.com/revenue/reference/get_products-parentid-option-groups-id-1.md): Retrieve a product option group
- [Update a product option group](https://developer.conga.com/revenue/reference/patch_products-parentid-option-groups-id-1.md): Update a product option group
- [Delete a product option group](https://developer.conga.com/revenue/reference/delete_products-parentid-option-groups-id-1.md): Delete a product option group
- [Retrieve product option groups](https://developer.conga.com/revenue/reference/get_products-parentid-option-groups-1.md): Retrieve product option groups
- [Create product option groups](https://developer.conga.com/revenue/reference/post_products-parentid-option-groups-1.md): Create product option groups
- [Update product option groups](https://developer.conga.com/revenue/reference/patch_products-parentid-option-groups-1.md): Update product option groups
- [Delete product option groups](https://developer.conga.com/revenue/reference/delete_products-parentid-option-groups-1.md): Delete product option groups
- [Add multiple existing OptionGroups as sub OptionGroups to Product Bundle](https://developer.conga.com/revenue/reference/post_products-parentid-option-groups-id-bulk.md): Create product option groups
- [Fetch ProductOptionComponents](https://developer.conga.com/revenue/reference/get_products-parentid-option-groups-id-components-1.md): Fetch ProductOptionComponents
- [Retrieve proposal locations](https://developer.conga.com/revenue/reference/get_quotes-parentid-locations-1.md): Retrieves a collection of proposal locations based on the parent proposal.
- [Create proposal locations](https://developer.conga.com/revenue/reference/post_quotes-parentid-locations-1.md): Creates one or more proposal locations to the collection. The parent proposal is automatically filled.
- [Update proposal locations](https://developer.conga.com/revenue/reference/patch_quotes-parentid-locations-1.md): Updates one or more proposal locations in the collection. Parent reassignment is not allowed.
- [Delete proposal locations](https://developer.conga.com/revenue/reference/delete_quotes-parentid-locations-1.md): Deletes one or more proposal locations from the collection.
- [Retrieve a proposal location](https://developer.conga.com/revenue/reference/get_quotes-parentid-locations-id-1.md): Retrieves a single proposal location document based on the identifier and parent proposal.
- [Update a proposal location](https://developer.conga.com/revenue/reference/patch_quotes-parentid-locations-id-1.md): Updates a single proposal location document based on the identifier and parent proposal.
- [Delete a proposal location](https://developer.conga.com/revenue/reference/delete_quotes-parentid-locations-id-1.md): Deletes a single proposal location document based on the identifier and parent proposal.
- [Retrieve related incentives](https://developer.conga.com/revenue/reference/get_incentives-parentid-related-incentives-1.md): Retrieves a collection of related incentives based on the parent incentive.
- [Create related incentives](https://developer.conga.com/revenue/reference/post_incentives-parentid-related-incentives-1.md): Creates one or more related incentives to the collection. The parent incentive is automatically filled.
- [Update related incentives](https://developer.conga.com/revenue/reference/patch_incentives-parentid-related-incentives-1.md): Updates one or more related incentives in the collection. Parent reassignment is not allowed.
- [Delete related incentives](https://developer.conga.com/revenue/reference/delete_incentives-parentid-related-incentives-1.md): Deletes one or more related incentives from the collection.
- [Retrieve a related incentive](https://developer.conga.com/revenue/reference/get_incentives-parentid-related-incentives-id-1.md): Retrieves a single related incentive document based on the identifier and parent incentive.
- [Update a related incentive](https://developer.conga.com/revenue/reference/patch_incentives-parentid-related-incentives-id-1.md): Updates a single related incentive document based on the identifier and parent incentive.
- [Delete related incentive](https://developer.conga.com/revenue/reference/delete_incentives-parentid-related-incentives-id-1.md): Deletes a single related incentive document based on the identifier and parent incentive.
- [Retrive related price list items](https://developer.conga.com/revenue/reference/get_price-list-items-parentid-related-price-list-items-1.md): Retrieves a collection of related price list items based on the parent price list item.
- [Create related price list items](https://developer.conga.com/revenue/reference/post_price-list-items-parentid-related-price-list-items-1.md): Creates one or more related price list items to the collection. The parent price list item is automatically filled.
- [Update related price list items](https://developer.conga.com/revenue/reference/patch_price-list-items-parentid-related-price-list-items-1.md): Updates one or more related price list items in the collection. Parent reassignment is not allowed.
- [Delete related price list items](https://developer.conga.com/revenue/reference/delete_price-list-items-parentid-related-price-list-items-1.md): Deletes one or more related price list items from the collection.
- [Retrieve a related price list item](https://developer.conga.com/revenue/reference/get_price-list-items-parentid-related-price-list-items-id-1.md): Retrieves a single related price list item document based on the identifier and parent price list item.
- [Update a related price list item](https://developer.conga.com/revenue/reference/patch_price-list-items-parentid-related-price-list-items-id-1.md): Update a single related price list item document based on the identifier and parent price list item.
- [Delete a related price list item](https://developer.conga.com/revenue/reference/delete_price-list-items-parentid-related-price-list-items-id-1.md): Deletes a single related price list item document based on the identifier and parent price list item.
- [Retrieve active storefront](https://developer.conga.com/revenue/reference/get_storefronts-active-1.md): Retrieves the active storefront by its identifier.
- [Retrieve storefronts](https://developer.conga.com/revenue/reference/get_storefronts-1.md): Retrieves the list of storefront records.
- [Create storefronts](https://developer.conga.com/revenue/reference/post_storefronts-1.md): Creates one or more storefronts based on details provided in the request body.
- [Update storefronts](https://developer.conga.com/revenue/reference/patch_storefronts-1.md): Updates one or more storefront based on the details provided in the request body.
- [Delete storefronts](https://developer.conga.com/revenue/reference/delete_storefronts-1.md): Deletes one or more storefront records based on the IDs provided in the request body.
- [Retrieve a storefront](https://developer.conga.com/revenue/reference/get_storefronts-id-1.md): Retrieves a single storefront record.
- [Update a storefront](https://developer.conga.com/revenue/reference/patch_storefronts-id-1.md): Updates a single storefront record.
- [Delete a storefront](https://developer.conga.com/revenue/reference/delete_storefronts-id-1.md): Deletes a storefront record.
- [Retrieve type-ahead results](https://developer.conga.com/revenue/reference/get_objectname-type-ahead-1.md): Retrieves the type-ahead results.
- [Validate data of an object for a given criteria](https://developer.conga.com/revenue/reference/post_objectname-validate.md)
- [Validate data of multiple objects](https://developer.conga.com/revenue/reference/post_validate.md)
- [Retrieve visibility rules](https://developer.conga.com/revenue/reference/get_visibility-rule-1.md): Retrieves the list of all visibility rules in system. Use record name to narrow down the search. The API returns the following fields:
 <ul><li>Name</li><li>IsActive</li><li>Business Object</li><li>Description</li></ul>
- [Create visibility rules](https://developer.conga.com/revenue/reference/post_visibility-rule-1.md): Creates one or more visibility rules, based on details in the request body, to control which products are displayed in the catalog.
- [Update visibility rules](https://developer.conga.com/revenue/reference/patch_visibility-rule-1.md): Updates one or more visibility rules, which control which products are displayed in the catalog. Visibility rules are updated based on the requested details.
- [Delete visibility rules](https://developer.conga.com/revenue/reference/delete_visibility-rule-1.md): Deletes one or more visibility rules.
- [Retrieve a visibility rule](https://developer.conga.com/revenue/reference/get_visibility-rule-id-1.md): Retrieves a single visibility rule by its identifier.
- [Update a visibility rule](https://developer.conga.com/revenue/reference/patch_visibility-rule-id-1.md): Updates a single visibility rule.
- [Delete a visibility rule](https://developer.conga.com/revenue/reference/delete_visibility-rule-id-1.md): Deletes a single visibility rule by its identifier.
- [Retrieve waterfall charts](https://developer.conga.com/revenue/reference/get_waterfalls-parentid-charts-1.md): Retrieves all waterfall charts in a waterfall with it's details. Use query parameters to further narrow down the retrieved results.
- [Create waterfall charts](https://developer.conga.com/revenue/reference/post_waterfalls-parentid-charts-1.md): Creates one or more waterfall charts for a specific waterfall.
- [Update waterfall charts](https://developer.conga.com/revenue/reference/patch_waterfalls-parentid-charts-1.md): Updates specific fields on one or more waterfall charts. It can update any fields except waterfall ID.
- [Delete waterfall charts](https://developer.conga.com/revenue/reference/delete_waterfalls-parentid-charts-1.md): Deletes one or more waterfall charts.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a waterfall chart](https://developer.conga.com/revenue/reference/get_waterfalls-parentid-charts-id-1.md): Retrieves a single waterfall chart document based on the identifier and parent waterfall.
- [Update a waterfall chart](https://developer.conga.com/revenue/reference/patch_waterfalls-parentid-charts-id-1.md): Updates a single waterfall chart document based on the identifier and parent waterfall.
- [Delete a waterfall chart](https://developer.conga.com/revenue/reference/delete_waterfalls-parentid-charts-id-1.md): Deletes a single waterfall chart document based on the identifier and parent waterfall.
- [Retrieve waterfall rules](https://developer.conga.com/revenue/reference/get_waterfall-rule-sets-parentid-rules-1.md): Retrieves all waterfall rules in a waterfall rule set, with their details. Use query parameters to further narrow down the retrieved results.
- [Create waterfall rules](https://developer.conga.com/revenue/reference/post_waterfall-rule-sets-parentid-rules-1.md): Creates one or more waterfall rules for a specific waterfall rule set.
- [Update waterfall rules](https://developer.conga.com/revenue/reference/patch_waterfall-rule-sets-parentid-rules-1.md): Updates specific fields on one or more waterfall rules. It can update any fields except waterfall rule ID.
- [Delete waterfall rules](https://developer.conga.com/revenue/reference/delete_waterfall-rule-sets-parentid-rules-1.md): Deletes one or more waterfall rules from a waterfall rule set. It can delete a maximum of 100 waterfall rules. When you delete a waterfall rule, CPQ deletes its related waterfall rule entries.
- [Retrieve a waterfall rule](https://developer.conga.com/revenue/reference/get_waterfall-rule-sets-parentid-rules-id-1.md): Retrieves a single waterfall rule document based on the identifier and parent waterfall ruleset.
- [Update a waterfall rule](https://developer.conga.com/revenue/reference/patch_waterfall-rule-sets-parentid-rules-id-1.md): Updates a single waterfall rule document based on the identifier and parent waterfall ruleset.
- [Delete a waterfall rule](https://developer.conga.com/revenue/reference/delete_waterfall-rule-sets-parentid-rules-id-1.md): Deletes a single waterfall rule document based on the identifier and parent waterfall ruleset.
- [Retrieve waterfall rule entries](https://developer.conga.com/revenue/reference/get_waterfall-rules-parentid-entries-1.md): Retrieves all waterfall rule entries in a waterfall rule, with their details. Use query parameters to further narrow down the retrieved results.
  When executed, this API returns all waterfall rule entries in a waterfall rule.
- [Create waterfall rule entries](https://developer.conga.com/revenue/reference/post_waterfall-rules-parentid-entries-1.md): Ccreates one or more waterfall rule entries. It can create a maximum of 100 waterfall rule entries for a particular waterfall rule.
  When executed, this API returns a unique waterfall rule entry ID (string) that CPQ automatically generates.
- [Update waterfall rule entries](https://developer.conga.com/revenue/reference/patch_waterfall-rules-parentid-entries-1.md): Updates specific fields on one or more waterfall rule entries. It can update any fields except waterfall rule entry ID.
 
  When executed, this API returns the updated waterfall rule entry or waterfall rule entries.
- [Delete waterfall rule entries](https://developer.conga.com/revenue/reference/delete_waterfall-rules-parentid-entries-1.md): Deletes one or more waterfall rule entries from a specific waterfall rule of type condition or dimension.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a waterfall rule entry](https://developer.conga.com/revenue/reference/get_waterfall-rules-parentid-entries-id-1.md): Retrieves a single waterfall rule entry document based on the identifier and parent waterfall rule.
- [Update a waterfall rule entry](https://developer.conga.com/revenue/reference/patch_waterfall-rules-parentid-entries-id-1.md): Updates a single waterfall rule entry document based on the identifier and parent waterfall rule.
- [Delete a waterfall rule entry](https://developer.conga.com/revenue/reference/delete_waterfall-rules-parentid-entries-id-1.md): Deletes a single waterfall rule entry document based on the identifier and parent waterfall rule.
- [Retrieve waterfall rulesets](https://developer.conga.com/revenue/reference/get_waterfall-rule-sets-1.md): Retrieves the collection of waterfall rulesets.
- [Create waterfall rulesets](https://developer.conga.com/revenue/reference/post_waterfall-rule-sets-1.md): Creates multiple waterfall rulesets.
- [Update waterfall rulesets](https://developer.conga.com/revenue/reference/patch_waterfall-rule-sets-1.md): Updates multiple waterfall rulesets.
- [Delete waterfall rulesets](https://developer.conga.com/revenue/reference/delete_waterfall-rule-sets-1.md): Deletes multiple waterfall rulesets.
- [Retrieve a waterfall ruleset](https://developer.conga.com/revenue/reference/get_waterfall-rule-sets-id-1.md): Retrieves a single waterfall ruleset by its identifier.
- [Update a waterfall ruleset](https://developer.conga.com/revenue/reference/patch_waterfall-rule-sets-id-1.md): Updates a single waterfall ruleset.
- [Delete a waterfall ruleset](https://developer.conga.com/revenue/reference/delete_waterfall-rule-sets-id-1.md): Deletes a single waterfall ruleset by its identifier.
- [Retrieve waterfalls](https://developer.conga.com/revenue/reference/get_waterfalls-1.md): Retrieves the collection of waterfalls.
- [Create waterfalls](https://developer.conga.com/revenue/reference/post_waterfalls-1.md): Creates multiple waterfalls.
- [Update waterfalls](https://developer.conga.com/revenue/reference/patch_waterfalls-1.md): Updates multiple waterfalls.
- [Delete waterfalls](https://developer.conga.com/revenue/reference/delete_waterfalls-1.md): Deletes multiple waterfalls.
- [Retrieve a waterfall](https://developer.conga.com/revenue/reference/get_waterfalls-id-1.md): Retrieves a single waterfall by its identifier.
- [Update a waterfall](https://developer.conga.com/revenue/reference/patch_waterfalls-id-1.md): Updates a single waterfall.
- [Delete a waterfall](https://developer.conga.com/revenue/reference/delete_waterfalls-id-1.md): Deletes a single waterfall by its identifier.
- [List name of ResponseFieldConfiguration.](https://developer.conga.com/revenue/reference/get_responsefield-configuration-categoryname.md): Retrieves the list of configuration name of responsefield configuration.
- [Get FieldSetConfiguration By Name](https://developer.conga.com/revenue/reference/get_responsefield-configuration-categoryname-configname.md): Get the FieldSetConfiguration By Name
- [Update FieldSetconfiguration](https://developer.conga.com/revenue/reference/put_responsefield-configuration-categoryname-configname.md): Update the existing configuration
- [Delete FieldSetconfiguration](https://developer.conga.com/revenue/reference/delete_responsefield-configuration-categoryname-configname.md): Delete configuration
- [Add a FieldSetconfiguration](https://developer.conga.com/revenue/reference/post_responsefield-configuration-categoryname-defaultconfigname-newconfigname.md): Creates a new configuration
- [Retrieve tax codes](https://developer.conga.com/revenue/reference/get_tax-codes.md): Retrieves all tax codes. Use query parameters to further narrow the results.
  When executed, this API returns all tax codes.
- [Create tax codes](https://developer.conga.com/revenue/reference/post_tax-codes.md): Creates one or more tax codes.
 
  When executed, this API returns a unique tax code ID (string) that CPQ automatically generates.
- [Update tax codes](https://developer.conga.com/revenue/reference/patch_tax-codes.md): Update specific fields on one or more tax codes. It can update any fields except tax code ID.
 
  When executed, this API returns the updated tax code or tax codes.
- [Delete tax codes](https://developer.conga.com/revenue/reference/delete_tax-codes.md): Deletes one or more tax codes. It can delete a maximum of 100 tax codes.
 
  When executed, this API returns one or more records with the delete status of each associated record ID.
- [Retrieve a tax code](https://developer.conga.com/revenue/reference/get_tax-codes-id.md): Retrieves details of a tax code associated with the provided tax code ID.
- [Update a tax code](https://developer.conga.com/revenue/reference/patch_tax-codes-id.md): Updates a tax code based on the details provided in the request body.
- [Delete a tax code](https://developer.conga.com/revenue/reference/delete_tax-codes-id.md): Deletes a tax code based on the ID provided.
- [Retrieves a list of favorite configurations.](https://developer.conga.com/revenue/reference/get_favorites.md)
- [Retrieves a favorite configuration by its identifier.](https://developer.conga.com/revenue/reference/get_favorites-id.md)
- [List field sets](https://developer.conga.com/revenue/reference/get_field-sets.md): Retrieves the list of field sets.
- [List fieldset fields](https://developer.conga.com/revenue/reference/get_field-sets-name.md): Retrieves the list of fields for a fieldset.
- [Update fields in fieldset](https://developer.conga.com/revenue/reference/put_field-sets-name.md): Add/Remove fields in a fieldset.
- [Retrieve all feature settings.](https://developer.conga.com/revenue/reference/get_feature-settings.md)
- [Update the specified FeatureSettings](https://developer.conga.com/revenue/reference/patch_feature-settings.md): Updates one or more feature settings with the provided boolean values.
 All feature setting keys must be valid and non-empty.
- [Retrieve a single feature setting by name.](https://developer.conga.com/revenue/reference/get_feature-settings-featuresettingname.md)
- [Retrieve Rebate Programs](https://developer.conga.com/revenue/reference/get_programs.md): Retrieves the collection of rebate programs.
- [Create Rebate Programs](https://developer.conga.com/revenue/reference/post_programs.md): Creates multiple rebate programs
- [Update Rebate Programs](https://developer.conga.com/revenue/reference/patch_programs.md): Updates multiple rebate programs
- [Delete Rebate Programs](https://developer.conga.com/revenue/reference/delete_programs.md): Deletes multiple rebate programs
- [Retrieve a Rebate Program](https://developer.conga.com/revenue/reference/get_programs-id.md): Retrieves a single rebate program by its identifier.
- [Update a Rebate Program](https://developer.conga.com/revenue/reference/patch_programs-id.md): Updates a single rebate program
- [Delete a Rebate Program](https://developer.conga.com/revenue/reference/delete_programs-id.md): Deletes a single rebate program by its identifier.
- [Retrieve incentive conditions](https://developer.conga.com/revenue/reference/get_rebates-parentid-conditions.md): Retrieves a collection of incentive conditions.
- [Create incentive conditions](https://developer.conga.com/revenue/reference/post_rebates-parentid-conditions.md): Adds one or more incentive conditions to the collection.
- [Update incentive conditions](https://developer.conga.com/revenue/reference/patch_rebates-parentid-conditions.md): Updates one or more incentive conditions in the collection.
- [Delete incentive conditions](https://developer.conga.com/revenue/reference/delete_rebates-parentid-conditions.md): Deletes one or more incentive conditions from the collection.
- [Retrieve a incentive condition](https://developer.conga.com/revenue/reference/get_rebates-parentid-conditions-id.md): Retrieves a single incentive condition.
- [Update a incentive condition](https://developer.conga.com/revenue/reference/patch_rebates-parentid-conditions-id.md): Updates a single incentive condition.
- [Delete a incentive condition](https://developer.conga.com/revenue/reference/delete_rebates-parentid-conditions-id.md): Deletes a single incentive condition.
- [Retrieve rebate rule entries](https://developer.conga.com/revenue/reference/get_rebate-rules-parentid-entries.md): Retrieves a collection of rebate rule entries based on the parent rebate rule.
- [Create rebate rule entries](https://developer.conga.com/revenue/reference/post_rebate-rules-parentid-entries.md): Adds one or more rebate rule entries to the collection. The parent rebate rule is automatically filled.
- [Update rebate rule entries](https://developer.conga.com/revenue/reference/patch_rebate-rules-parentid-entries.md): Updates one or more rebate rule entries in the collection. Parent reassignment is not allowed.
- [Delete rebate rule entries](https://developer.conga.com/revenue/reference/delete_rebate-rules-parentid-entries.md): Deletes one or more rebate rule entries from the collection.
- [Retrieve a rebate rule entry](https://developer.conga.com/revenue/reference/get_rebate-rules-parentid-entries-id.md): Retrieves a single rebate rule entry document based on the identifier and parent rebate rule.
- [Update a rebate rule entry](https://developer.conga.com/revenue/reference/patch_rebate-rules-parentid-entries-id.md): Updates a single rebate rule entry document based on the identifier and parent rebate rule.
- [Delete a rebate rule entry](https://developer.conga.com/revenue/reference/delete_rebate-rules-parentid-entries-id.md): Deletes a single rebate rule entry document based on the identifier and parent rebate rule.
- [Retrieve rebate rules](https://developer.conga.com/revenue/reference/get_rebates-parentid-rules.md): Retrieves a collection of rebate rules based on the parent rebate.
- [Create rebate rules](https://developer.conga.com/revenue/reference/post_rebates-parentid-rules.md): Adds one or more rebate rules to the collection. The parent rebate is automatically filled.
- [Update rebate rules](https://developer.conga.com/revenue/reference/patch_rebates-parentid-rules.md): Updates one or more rebate rules in the collection. Parent reassignment is not allowed.
- [Delete rebate rules](https://developer.conga.com/revenue/reference/delete_rebates-parentid-rules.md): Deletes one or more rebate rules from the collection.
- [Retrieve a rebate rule](https://developer.conga.com/revenue/reference/get_rebates-parentid-rules-id.md): Retrieves a single rebate rule document based on the identifier and parent rebate.
- [Update a rebate rule](https://developer.conga.com/revenue/reference/patch_rebates-parentid-rules-id.md): Updates a single rebate rule document based on the identifier and parent rebate.
- [Delete a rebate rule](https://developer.conga.com/revenue/reference/delete_rebates-parentid-rules-id.md): Deletes a single rebate rule document based on the identifier and parent rebate.
- [Retrieve rebates](https://developer.conga.com/revenue/reference/get_rebates.md): Retrieves the collection of rebates.
- [Create rebates](https://developer.conga.com/revenue/reference/post_rebates.md): Creates multiple rebates.
- [Update rebates](https://developer.conga.com/revenue/reference/patch_rebates.md): Updates multiple rebates.
- [Delete rebates](https://developer.conga.com/revenue/reference/delete_rebates.md): Deletes multiple rebates.
- [Retrieve a rebate](https://developer.conga.com/revenue/reference/get_rebates-id.md): Retrieves a single rebate by its identifier.
- [Update a rebate](https://developer.conga.com/revenue/reference/patch_rebates-id.md): Updates a single rebate.
- [Delete a rebate](https://developer.conga.com/revenue/reference/delete_rebates-id.md): Deletes a single rebate by its identifier.
- [Clone rebate](https://developer.conga.com/revenue/reference/post_rebates-id-clone.md): Clones rebate.
- [Retrieve Incentive Programs](https://developer.conga.com/revenue/reference/get_incentive-programs-1.md): Retrieves the collection of incentive programs.
- [Create Incentive Programs](https://developer.conga.com/revenue/reference/post_incentive-programs-1.md): Creates multiple Incentive programs
- [Update Incentive Programs](https://developer.conga.com/revenue/reference/patch_incentive-programs-1.md): Updates multiple Incentive programs
- [Delete Incentive Programs](https://developer.conga.com/revenue/reference/delete_incentive-programs-1.md): Deletes multiple Incentive programs
- [Retrieve an Incentive Program](https://developer.conga.com/revenue/reference/get_incentive-programs-id-1.md): Retrieves a single incentive program by its identifier.
- [Update an Incentive Program](https://developer.conga.com/revenue/reference/patch_incentive-programs-id-1.md): Updates a single Incentive program
- [Delete an Incentive Program](https://developer.conga.com/revenue/reference/delete_incentive-programs-id-1.md): Deletes a single Incentive program by its identifier.
- [Associate price program to businessObjects](https://developer.conga.com/revenue/reference/post_price-program-associations.md): Creates multiple associations.
- [List businessObject details which are associated with the given priceProgramId](https://developer.conga.com/revenue/reference/get_price-programs-priceprogramid-business-objects.md): List BusinessObject Details.
- [List price program details which are associated with the given businessObjectId](https://developer.conga.com/revenue/reference/get_business-objects-businessobjectid-price-programs.md): List Price Program details.
- [Disassociate a price program from businessObjects based on the given priceProgramId and businessObjectIds.](https://developer.conga.com/revenue/reference/delete_price-programs-priceprogramid-price-program-associations.md): Deletes IncentiveAssociation based on priceProgramId and businessObjectIds.
- [Disassociate a businessObject from price programs based on the given businessObjectId and priceProgramIds.](https://developer.conga.com/revenue/reference/delete_business-objects-businessobjectid-price-program-associations.md): Deletes IncentiveAssociation based on businessObjectId and priceProgramIds.
- [Retrieve incentive rule entries](https://developer.conga.com/revenue/reference/get_price-program-rules-parentid-entries-1.md): Retrieves a collection of incentive rule entries based on the parent incentive rule.
- [Create incentive rule entries](https://developer.conga.com/revenue/reference/post_price-program-rules-parentid-entries-1.md): Adds one or more incentive rule entries to the collection. The parent incentive rule is automatically filled.
- [Update incentive rule entries](https://developer.conga.com/revenue/reference/patch_price-program-rules-parentid-entries-1.md): Updates one or more incentive rule entries in the collection. Parent reassignment is not allowed.
- [Delete incentive rule entries](https://developer.conga.com/revenue/reference/delete_price-program-rules-parentid-entries-1.md): Deletes one or more incentive rule entries from the collection.
- [Retrieve an incentive rule entry](https://developer.conga.com/revenue/reference/get_price-program-rules-parentid-entries-id-1.md): Retrieves a single incentive rule entry document based on the identifier and parent incentive rule.
- [Update an incentive rule entry](https://developer.conga.com/revenue/reference/patch_price-program-rules-parentid-entries-id-1.md): Updates a single incentive rule entry document based on the identifier and parent incentive rule.
- [Delete an incentive rule entry](https://developer.conga.com/revenue/reference/delete_price-program-rules-parentid-entries-id-1.md): Deletes a single incentive rule entry document based on the identifier and parent incentive rule.
- [Retrieve incentive rules](https://developer.conga.com/revenue/reference/get_price-programs-parentid-rules-1.md): Retrieves a collection of incentive rules based on the parent incentive.
- [Create incentive rules](https://developer.conga.com/revenue/reference/post_price-programs-parentid-rules-1.md): Adds one or more incentive rules to the collection. The parent incentive is automatically filled.
- [Update incentive rules](https://developer.conga.com/revenue/reference/patch_price-programs-parentid-rules-1.md): Updates one or more incentive rules in the collection. Parent reassignment is not allowed.
- [Delete incentive rules](https://developer.conga.com/revenue/reference/delete_price-programs-parentid-rules-1.md): Deletes one or more incentive rules from the collection.
- [Retrieve an incentive rule](https://developer.conga.com/revenue/reference/get_price-programs-parentid-rules-id-1.md): Retrieves a single incentive rule document based on the identifier and parent incentive.
- [Update an incentive rule](https://developer.conga.com/revenue/reference/patch_price-programs-parentid-rules-id-1.md): Updates a single incentive rule document based on the identifier and parent incentive.
- [Delete an incentive rule](https://developer.conga.com/revenue/reference/delete_price-programs-parentid-rules-id-1.md): Deletes a single incentive rule document based on the identifier and parent incentive.
- [Retrieve incentives](https://developer.conga.com/revenue/reference/get_price-programs-1.md): Retrieves the collection of incentives.
- [Create incentives](https://developer.conga.com/revenue/reference/post_price-programs-1.md): Creates multiple incentives.
- [Update incentives](https://developer.conga.com/revenue/reference/patch_price-programs-1.md): Updates multiple incentives.
- [Delete incentives](https://developer.conga.com/revenue/reference/delete_price-programs-1.md): Deletes multiple incentives.
- [Retrieve an incentive](https://developer.conga.com/revenue/reference/get_price-programs-id-1.md): Retrieves a single incentive by its identifier.
- [Update an incentive](https://developer.conga.com/revenue/reference/patch_price-programs-id-1.md): Updates a single incentive.
- [Delete an incentive](https://developer.conga.com/revenue/reference/delete_price-programs-id-1.md): Deletes a single incentive by its identifier.
- [Create a custom plan template with  line items](https://developer.conga.com/revenue/reference/post_custom-plan-templates.md): This API allows you to create one or multiple custom billing plan templates in a single request. Each template can include 
 its own set of line items (installments or milestones), and the API validates all input before committing any records. 
 This endpoint is bulkified, so you can efficiently create several templates at once, and it provides detailed feedback for each record in the batch.
- [Edit custom plan template](https://developer.conga.com/revenue/reference/patch_custom-plan-templates.md): Edit multiple custom plan template records along with template line items and returns the updated custom plan template record IDs.
- [Retrieve a custom plan template record](https://developer.conga.com/revenue/reference/get_custom-plan-templates-plantemplateid.md): This API endpoint allows you to retrieve a specific custom Plan Template by its unique identifier (planTemplateId).
- [Activate or deactivate a list of custom plan templates](https://developer.conga.com/revenue/reference/patch_custom-plan-templates-activate.md): This API is used to activate or deactivate one or more custom Plan Templates in bulk. 
 You provide a list of template IDs along with the desired active status (true for activate, false for deactivate). The API processes each request individually, 
 validates prerequisites (such as template existence and readiness), and returns a batch response indicating the success or failure for each template.
- [Activate or deactivate a custom plan template](https://developer.conga.com/revenue/reference/patch_custom-plan-templates-plantemplateid-activate.md): This API allows you to activate or deactivate a specific custom plan template by passing its unique identifier (planTemplateId) 
 in the route and the desired status (active=true or active=false) as a query parameter. The API processes the request and updates the 
 template’s active status accordingly.
- [Create preferences](https://developer.conga.com/revenue/reference/post_preferences.md): The different properties in the Preference record will be used by the Billing engine to generate Billing Schedules.
- [Update preference records](https://developer.conga.com/revenue/reference/patch_preferences.md): Updates multiple preference records and returns the updated preference records with IDs.
- [List preference records](https://developer.conga.com/revenue/reference/get_preferences.md): Retrieves the collection of preference records.
 To access Billing Preference History records, ensure the "includes" parameter is set to "history".
- [Get a preference record](https://developer.conga.com/revenue/reference/get_preferences-preferenceid.md): Retrieves a single preference record by its identifier.
 To access Billing Preference History records, ensure the "includes" parameter is set to "history".
- [Mark the Preference record as default](https://developer.conga.com/revenue/reference/patch_preferences-id-default.md): Marks the passed ID of the preference record as org default. <p>**Note:** There can be only one default preference record.</p>
- [Activate or deactivate a list of preference records](https://developer.conga.com/revenue/reference/patch_preferences-activate.md): Toggles the Active flag for the ID's passed for preference records.
- [Activate or deactivate a preference record](https://developer.conga.com/revenue/reference/patch_preferences-preferenceid-activate.md): Toggles the Active flag for the ID passed for a preference record.
- [Create billing records based on Order Line Item (OLI) status](https://developer.conga.com/revenue/reference/post_schedules-initiate.md): Initiates billing for different types of products based on the status of the Order Line Items (OLIs). 
 The API processes multiple OLIs with different statuses (New, Amend, Renew, Terminate, etc.) and groups them 
 accordingly. It then triggers the appropriate billing actions for each group based on the status of each OLI.
 The grouping and billing actions are automatically handled based on the status, making it easier for the user to 
 initiate billing for various types of changes in the order.
   * **New Products:** Billing will be initiated as a new sale.
   * **Amendments:** Billing will be triggered based on the amended order line item details.
   * **Renewals:** Billing will be initiated for recurring products based on renewal details.
   * **Terminations:** Billing will be handled based on the termination of the product.
   * **Swap Products:** Billing will be initiated based on the swapped product details.
- [Create billing records](https://developer.conga.com/revenue/reference/post_schedules-new.md): Initiates billing for one-time and recurring products. It creates billing records when you pass orderLineItemIds and ReadyForBillingDate as parameters.
   * **One-Time Products:** If you set both the price type and the billing frequency to One-Time, the API creates only one billing schedule record.
   * **Recurring Products:** If you set the price type to Recurring and the billing frequency to Monthly, Quarterly, or Yearly, the API creates a cascade of billing schedule records, depending on the selling term.
- [Get Billing schedules by billing header](https://developer.conga.com/revenue/reference/get_schedules-billingheaderid.md): Fetches the billing header, billing schedule records, and billing schedule details when you pass the billing header ID as a parameter.
- [Apply adjustments to the billing schedule](https://developer.conga.com/revenue/reference/post_schedules-adjustments-apply-adjustment.md): Applies adjustment to billing schedule.
- [Invoice Status](https://developer.conga.com/revenue/reference/put_schedules-invoice-status-update.md): Update Status by passing list of Billing Schedule RecordId and Invoice Status.
- [Invoice Status](https://developer.conga.com/revenue/reference/put_schedules-scheduleid-invoice-status-update.md): Update Status by passing Billing Schedule RecordId and Invoice Status.
- [Terminate Schedules](https://developer.conga.com/revenue/reference/post_schedules-terminate.md): The API will Terminate Schedules for a Given Order Line item IDs.
- [Evergreen Renew](https://developer.conga.com/revenue/reference/post_schedules-evergreen-renew.md): Renew Evergreen Billing Header by passing Billing Header ID.
- [Evergreen Renew](https://developer.conga.com/revenue/reference/post_schedules-evergreen-scheduleid-renew.md): Renew Evergreen Billing Header by passing Billing Header Id
- [Renew Schedules](https://developer.conga.com/revenue/reference/post_schedules-renew.md): The API will Renew Schedules for a Given Order Line item IDs.
- [Amend Schedules](https://developer.conga.com/revenue/reference/post_schedules-amend.md): Amend billing for one-time and recurring products. It creates/updates billing records when you pass orderLineItemIds and ReadyForBillingDate as parameters.
- [Swap Schedules](https://developer.conga.com/revenue/reference/post_schedules-swap.md): The API will swap sold and earlier billed product when you pass OrderLineItemIds and ReadyForBillingDate as parameters.
- [Update the approval stage of a billing schedule detail](https://developer.conga.com/revenue/reference/put_schedules-adjustments-update-approval-stage.md): The API updates the approval stage of billing schedule detail when provided with BillingScheduleDetailId and approval stage.
- [Delete adjustment billing schedule details](https://developer.conga.com/revenue/reference/delete_schedules-delete-adjustments.md): The API deletes Adjustment billing schedule details based on the provided BillingScheduleDetailIds.
- [Create billing records](https://developer.conga.com/revenue/reference/post_schedules-orderid-initiate.md): Initiates billing for one-time and recurring products. It creates billing records when you pass order id and ReadyForBillingDate as parameter.
   * **One-Time Products:** If you set both the price type and the billing frequency to One-Time, the API creates only one billing schedule record.
   * **Recurring Products:** If you set the price type to Recurring and the billing frequency to Monthly, Quarterly, or Yearly, the API creates a cascade of billing schedule records, depending on the selling term.
- [Create payment term records](https://developer.conga.com/revenue/reference/post_payment-terms.md): Creates multiple payment term records and returns the created records with their IDs.
- [Update payment term records](https://developer.conga.com/revenue/reference/patch_payment-terms.md): Updates multiple payment term records and returns the updated payment term records with IDs.
- [Retrieve the collection of payment term records](https://developer.conga.com/revenue/reference/get_payment-terms.md): Retrieves the collection of payment term records
- [Activate or deactivate a list of payment term records](https://developer.conga.com/revenue/reference/patch_payment-terms-activate.md): Toggles the Active flag for the ID's passed for payment term records.
- [Activate or deactivate a payment term record](https://developer.conga.com/revenue/reference/patch_payment-terms-paymenttermid-activate.md): Toggles the Active flag for the ID passed for a payment term record.
- [Get a payment term record](https://developer.conga.com/revenue/reference/get_payment-terms-id.md): Retrieves a single payment term record by its identifier.
- [Mark the payment term record as default](https://developer.conga.com/revenue/reference/put_payment-terms-id-default.md): Marks the passed ID of the payment term record as org default. There can be only one default payment term record.
- [Create multiple product configuration records](https://developer.conga.com/revenue/reference/post_product-configurations.md): The Product Configuration records will contain the Billing configuration property which needs to be linked with the Product record.
- [Update product billing configurations](https://developer.conga.com/revenue/reference/patch_product-configurations.md): Updates multiple product billing configurations and returns the updated records with their IDs.
- [List product billing configuration records](https://developer.conga.com/revenue/reference/get_product-configurations.md): Retrieves the collection of product billing configuration records.
- [Get a product billing configuration record](https://developer.conga.com/revenue/reference/get_product-configurations-productconfigurationid.md): Retrieves a single product billing configuration record by its identifier.
- [Creates usage input records](https://developer.conga.com/revenue/reference/post_usage-inputs.md): Add usage input records which will be used for billing calculations
- [Updates usage input records](https://developer.conga.com/revenue/reference/patch_usage-inputs.md): Updates multiple usage inputs records and returns the updated record IDs.
- [List usage inputs records](https://developer.conga.com/revenue/reference/get_usage-inputs.md): Retrieves the collection of usage inputs records.
- [Deletes usage input records](https://developer.conga.com/revenue/reference/delete_usage-inputs.md)
- [Get a usage input record](https://developer.conga.com/revenue/reference/get_usage-inputs-usageinputid.md): Retrieves a single usage input record by its identifier.
- [Retrieve custom plans and their line items](https://developer.conga.com/revenue/reference/post_custom-plans-search.md): This API endpoint allows users to search and fetch custom plans and their corresponding line items. This endpoint is typically used in billing workflows where users need to retrieve customized plans and their detailed line items for invoicing, reporting, or subscription management.
- [Retrieve a custom plan record](https://developer.conga.com/revenue/reference/get_custom-plans-customplanid.md): Retrieves the details of a custom plan based on its unique identifier. This API is typically used when users need to fetch detailed information about a specific custom plan, optionally including related data for comprehensive insights.
- [Delete custom plan records](https://developer.conga.com/revenue/reference/delete_custom-plans.md): Deletes one or more custom plans along with their associated plan line items.
- [Create custom plan with plan line items](https://developer.conga.com/revenue/reference/post_line-items-custom-plans.md): This API endpoint allows you to create one or more custom billing plans for a set of line items 
 (such as Order Line Items or CPQ Cart Line Items) in a single request. This endpoint is designed to handle both 
 milestone and term-based custom plans, supporting flexible installment and billing configurations for each line item.
- [Edit custom plan and its line items](https://developer.conga.com/revenue/reference/put_line-items-custom-plans.md): This API enables you to update existing custom billing plans and their associated plan line items based on their IDs. You can update one or more line items in bulk. 
 This is especially useful for teams who need to adjust payment schedules, installment details, or other plan parameters after initial creation.
 You cannot edit the custom plan if the proposal is accepted, the agreement is activated, or any order line item is activated.
- [Create custom plans for given Order Line Item IDs](https://developer.conga.com/revenue/reference/post_order-line-items-custom-plans.md): Create multiple custom plan records with their plan line items for given Order Line Item Ids provided in each Request.
 On Successful execution It returns the new created Custom Plan record ID along with associated Order Line item Ids.
- [Edit custom plans for given Order Line Item IDs](https://developer.conga.com/revenue/reference/put_order-line-items-custom-plans.md): This API allows for the modification of custom plans and their related plan line items for Order Line Item.
- [Create forecast data](https://developer.conga.com/revenue/reference/post_forecast.md): Create forecast data for Proposal, Product Configuration, Order, LineItem, and OrderLineItem.
- [Retrieve forecast data](https://developer.conga.com/revenue/reference/get_forecast-businessobjecttype-businessobjectid.md): Retrieve forecast data for Proposal, Product Configuration, Order, LineItem, and OrderLineItem.
- [Regenerate forecast summary](https://developer.conga.com/revenue/reference/post_forecast-regenerate-forecast-summary.md): Regenerate forecast summary for Proposal, Product Configuration, Order based on Summary Criteria passed.
- [Get job status](https://developer.conga.com/revenue/reference/get_job-status-id-1.md): Retrieves job status details for the given job or record.
- [Mark billing schedule details complete](https://developer.conga.com/revenue/reference/put_milestone-complete.md): This API marks milestone-type billing schedule details as complete. When the milestones are complete, the actual fee amount is computed using the percentage of TCV (sales) contained in the BSDs.
- [Get billing schedule details for order line items](https://developer.conga.com/revenue/reference/post_milestone-order-line-item.md): The API fetches milestone-type billing schedule details for a list of order line-item IDs. Click **ADD OBJECT** to enter the required parameters. Click **ADD STRING** in the ObjectIds field to enter the order line item ID. Repeat this to add multiple order line item IDs.
- [Get billing schedule details for an order line item](https://developer.conga.com/revenue/reference/post_milestone-order-line-item-orderlineitemid.md): This API fetches the milestone-type billing schedule details for one order line item ID. Enter the order line item ID in the orderLineItemId field to fetch the billing schedule detail.
- [Get billing schedule details for billing headers](https://developer.conga.com/revenue/reference/post_milestone-header.md): The API fetches the milestone-type billing schedule details for a list of billing header IDs. Click **ADD OBJECT** to enter the required parameters. Click **ADD STRING** in the ObjectIds field to enter the billing header ID. Repeat this to add more billing header IDs.
- [Get billing schedule details for a billing header](https://developer.conga.com/revenue/reference/post_milestone-header-billingheaderid.md): The API fetches milestone-type billing schedule details for a billing header. Enter the billing header ID in the billingHeaderId field to fetch the billing schedule detail.
- [Get milestone-type billing schedule details by record IDs](https://developer.conga.com/revenue/reference/post_milestone-schedule-record.md): The API fetches milestone-type billing schedule details for a list of billing schedule record IDs. Click **ADD OBJECT** to enter the required parameters. Click **ADD STRING** in the ObjectIds field to enter the billing schedule record ID. Repeat this to add billing schedule record IDs.
- [Get milestone-type billing schedule details by a record ID](https://developer.conga.com/revenue/reference/post_milestone-schedule-record-schedulerecordid.md): The API fetches milestone-type billing schedule details for a billing schedule by record ID. Enter the billing schedule record ID in the scheduleRecordId field to fetch the billing schedule detail.
- [Rates the specified usage input records.](https://developer.conga.com/revenue/reference/post_usage-inputs-rate.md): The usage inputs can be processed in two modes:  
 Asynchronous mode: If UsageInputRatingRequest.ProcessAllUsageInputs is `true`, all usage input records with status as Loaded will be rated asynchronously.  
 The response will include a `JobId` to track the background operation.  
 Synchronous mode: If UsageInputRatingRequest.ProcessAllUsageInputs is `false`, only the records with IDs provided in UsageInputRatingRequest.UsageInputIds will be rated synchronously.  
 The response will include the batch results for the specified records.   
 This design allows the client to control: 
 - Whether the operation applies to all records or only a specific subset. 
 - Whether the operation is performed synchronously or asynchronously.
- [Reverses ratings for the specified usage input records.](https://developer.conga.com/revenue/reference/post_usage-inputs-unrate.md): Reverses ratings for the specified usage input records.
- [Estimates draft ratings for the specified usage input records without updating their final status.](https://developer.conga.com/revenue/reference/post_usage-inputs-estimate.md): The usage inputs can be processed in two modes:  
 Asynchronous mode: If UsageInputRatingRequest.ProcessAllUsageInputs is `true`, all loaded usage input records will be estimated asynchronously.  
 The response will include a `JobId` to track the background operation.  
 Synchronous mode: If UsageInputRatingRequest.ProcessAllUsageInputs is `false`, only the records with IDs provided in UsageInputRatingRequest.UsageInputIds will be estimated synchronously.  
 The response will include the batch results for the specified records.   
 Automatic async fallback: If `UsageInputRatingRequest.ProcessAllUsageInputs` is `false` but the number of values in 
 `UsageInputRatingRequest.UsageInputIds` exceeds the configured threshold, the request will be processed 
 asynchronously regardless of mode selection, and the response will include a `JobId`.   
 This design allows the client to control: 
 - Whether the operation applies to all records or only a specific subset. 
 - Whether the operation is performed synchronously or asynchronously, subject to system thresholds.
- [Approve one or more credit memos](https://developer.conga.com/revenue/reference/post_creditmemos-approve.md): This endpoint allows bulk approval of credit memos. Each credit memo is processed independently,
 enabling partial success scenarios where some credit memos may be approved while others fail validation.
             
 **Conditions:**
 - Only credit memos with status 'Draft' or 'Pending Approval' can be approved.
             
 **Effects of approval:**
 - Credit memo status is updated to 'Approved'.
 - All related Credit Memo Line Items are approved.
 - Related Billing Schedule Records and Billing Schedule Details are marked as 'Invoiced'.
 - Billing Header Rollup - Total Invoice Amount and Total Pending Amount are updated.
- [Retrieve credit memo details](https://developer.conga.com/revenue/reference/get_creditmemos-id.md): This method fetches an existing credit memo from the data store and translates it
 to a response object that can be sent to clients. The method supports viewing the details
 of a previously created credit memo.
- [Cancels one or more credit memos.](https://developer.conga.com/revenue/reference/post_creditmemos-cancel.md): This endpoint allows bulk cancellation of credit memos. Each credit memo is processed independently,
 enabling partial success scenarios where some credit memos may be cancelled while others fail validation.
             
 **Conditions:**
 - Only credit memos with status 'Approved' and payment status 'Uncredited' can be cancelled.
             
 **Effects of Cancellation:**
 - Credit memo status is updated to 'Cancelled'.
 - All related Credit Memo Line Items are Cancelled.
 - Billing Header Rollup - Total Credit Memo Amount and Total Pending Amount are updated.
- [Retrieve invoice details](https://developer.conga.com/revenue/reference/get_invoices-id.md): This method fetches an existing invoice from the data store and translates it
 to a response object that can be sent to clients. The method supports viewing the details
 of a previously created invoice.
- [Approve one or more invoices](https://developer.conga.com/revenue/reference/post_invoices-approve.md): This endpoint allows bulk approval of invoices. Each invoice is processed independently,
 enabling partial success scenarios where some invoices may be approved while others fail validation.
             
 **Conditions:**
 - Only invoices with status 'Draft' or 'Pending Approval' can be approved.
             
 **Effects of approval:**
 - Invoice status is updated to 'Approved'.
 - All related Invoice Line Items are approved.
 - Related Billing Schedule Records and Billing Schedule Details are marked as 'Invoiced'.
 - Billing Header Rollup - Total Invoice Amount and Total Pending Amount are updated.
- [Cancels one or more invoices.](https://developer.conga.com/revenue/reference/post_invoices-cancel.md): This endpoint allows bulk cancellation of invoices. Each invoice is processed independently,
 enabling partial success scenarios where some invoices may be cancelled while others fail validation.
             
 **Conditions:**
 - Only invoices with status 'Approved' and payment status 'Unpaid' can be cancelled.
             
 **Effects of Cancellation:**
 - Invoice status is updated to 'Cancelled'.
 - All related Invoice Line Items are Cancelled.
 - Billing Header Rollup - Total Invoice Amount and Total Pending Amount are updated.
- [Retrieves an invoice request result by its identifier.](https://developer.conga.com/revenue/reference/get_request-results-id.md)
- [Retrieves all invoices associated with a specific invoice request result.](https://developer.conga.com/revenue/reference/get_request-results-id-invoices.md)
- [Gets a list of split criteria setups based on the provided query parameters.](https://developer.conga.com/revenue/reference/get_split-criteria.md)
- [Creates a new split criteria setup based on the provided request data.](https://developer.conga.com/revenue/reference/post_split-criteria.md)
- [Updates multiple split criteria setups based on the provided request data.](https://developer.conga.com/revenue/reference/patch_split-criteria.md): Partial success is supported; if some records are invalid or fail to update, the response
             will include details for each record and use status code 207 (Multi-Status). The order of responses corresponds
             to the order of input records.
- [Gets a split criteria setup by its unique identifier.](https://developer.conga.com/revenue/reference/get_split-criteria-id.md)
- [Toggles the active status of the specified split criteria setups.](https://developer.conga.com/revenue/reference/patch_split-criteria-activate.md): This method processes the provided requests to toggle the active status of the specified
             split criteria setups. It returns a 207 Multi Status code on partial success or a 400 Bad Request status code if the
             input is invalid.
- [Activates the split criteria setup identified by the specified ID.](https://developer.conga.com/revenue/reference/patch_split-criteria-id-activate.md)
- [Configures and creates an invoice run request based on the provided configuration.](https://developer.conga.com/revenue/reference/post_configure-requests.md)
- [Updates an existing invoice configuration request with modified settings.](https://developer.conga.com/revenue/reference/patch_configure-requests.md)
- [Retrieves an invoice configuration request by its unique identifier.](https://developer.conga.com/revenue/reference/get_configure-requests-id.md)
- [Clones an existing invoice configuration request to create a new configuration based on the specified source.](https://developer.conga.com/revenue/reference/post_configure-requests-id-clone.md)
- [Retrieves a preview of an invoice request, including billing schedule records and estimated invoice details.](https://developer.conga.com/revenue/reference/get_configure-requests-id-estimate.md)
- [Retrieves a preview of an invoice request based on the provided configuration without persisting the request.](https://developer.conga.com/revenue/reference/post_configure-requests-estimate.md)
- [Retrieves an invoice request result by configuration request identifier.](https://developer.conga.com/revenue/reference/get_configure-requests-id-request-results.md)

## Recipes
- [Add a Product to the Cart by ID](https://developer.conga.com/revenue/recipes/add-a-product-to-the-cart-by-id.md)
- [GraphQL - Fetch Cart Data](https://developer.conga.com/revenue/recipes/graphql-fetch-cart-data.md)
- [GraphQL - Subscribe to Cart](https://developer.conga.com/revenue/recipes/graphql-subscribe-to-cart.md)


# Document Automation Documentation

> Approvals, Composer, and Sign

## Guides
- [Documentation](https://developer.conga.com/doc-automation/docs.md): Document Automation documentation

## API Reference
- [Generate a document from merge templates and data sources](https://developer.conga.com/doc-automation/reference/documents_generate-1.md): Generates a document by merging one or more templates with data collected from multiple sources.              EXAMPLE I: Merging a single XAuthor template with data fetched from Conga Platform and generating a PDF document as output.                  Request:                  POST /documents/generate     {         "data": [             {                 "entityId": "3ff0e051-d655-451d-abb5-a71b202cb935",                 "entityName": "Agreement"             }         ],         "templates": [             {                 "id": "79d97cc6-933b-4f2f-95b6-a64d3349f3ac"             }         ],         "outputConfig": {             "outputFormat": 1, // 0 -> DOCX     1 -> PDF             "fileName": "OutputDocument"         }     }                  Response:     {         "job": {             "status": 0,             "errorReason": null,             "id": "64d30d4a-5c89-4d9f-a5c8-b8453af5c280",             "createdDate": "2023-07-15T12:41:27.1363101Z",         },         "success": true,         "statusCode": 202,         "message": "Successfully queued the request"     }              EXAMPLE II: Merging a single XAuthor template with inline data passed in the request and generating a PDF.                  Request:                  POST /documents/generate     {         "data": [             {                 "entityId": "ffe71825-6212-4438-866e-b0a7785d9e0d",                 "entityName": "ProductConfiguration",                 "Data": "[{\"ObjectName\":\"ProductConfiguration\",\"Result\":[{\"Id\":\"481450d8-9e7c-4dd7-898f-ae8cb1691b94\",\"Name\":\"481450d8-9e7c-4dd7-898f-ae8cb1691b94\"}]},{\"ObjectName\":\"LineItem\",\"Result\":[{\"Id\":\"553dc3ad-4a9a-4eb2-960e-7bb2b19e0727\",\"Name\":\"Conga Water Bottle\",\"Description\":\"Stay hydrated on the ice-cold tears of your competition.\",\"Quantity\":1,\"Product\":{\"Id\":\"9b319b18-1916-4858-b4e8-4ee2b55f83e5\",\"Name\":\"Conga Water Bottle\",\"Description\":null},\"Configuration\":{\"Id\":\"481450d8-9e7c-4dd7-898f-ae8cb1691b94\",\"Name\":\"481450d8-9e7c-4dd7-898f-ae8cb1691b94\"}}]}]"             }         ],         "templates": [             {                 "id": "950039fe-3ca3-49be-ba89-6d8999083a28"             }         ],         "outputConfig": {             "outputFormat": 1,             "fileName": "OutputDocument"         }     }
- [Join documents from multiple sources](https://developer.conga.com/doc-automation/reference/documents_join-1.md): Joins documents fetched from multiple sources into a single document. The joined document can be delivered to one or more destinations.              EXAMPLE I: Fetching Word documents from the Conga Platform and generating a combined PDF.                  Request:                  POST /documents/join     {         "documents": [             {                 "id": "420326c7-aaa4-4598-a072-48e8cbbe442d"             },             {                 "id": "b04393b5-16c2-4364-9ea3-a3d3c38453e1"             }         ],         "outputConfig": {             "outputFormat": 1,             "fileName": "JoinedDocument"         }     }                  Response:     {         "job": {             "status": 0,             "errorReason": null,             "id": "64d30d4a-5c89-4d9f-a5c8-b8453af5c280",             "createdDate": "2023-07-15T12:41:27.1363101Z",         },         "success": true,         "statusCode": 202,         "message": "Successfully queued the request"     }
- [Change document protection](https://developer.conga.com/doc-automation/reference/documents_protect-1.md): Applies protection to, or removes it from, one or more documents fetched from one or more sources. Generated documents can be delivered to one or more destinations.              EXAMPLE I: Apply an edit restriction to Word documents stored on the Conga Revenue Lifecycle Platform.                  Request:                  POST /documents/protect     {         "documents": [             {                 "id": "420326c7-aaa4-4598-a072-48e8cbbe442d"             },             {                 "id": "b04393b5-16c2-4364-9ea3-a3d3c38453e1"             }         ],         "wordProtectionConfig": {             "RestrictionType": 3, // NoProtection -> -1 | AllowOnlyRevisions -> 0 | AllowOnlyComments -> 1 | AllowOnlyFormFields -> 2             "restrictionPassword": "Your password goes here"         }     }                  Response:     {         "job": {             "status": 0,             "errorReason": null,             "id": "64d30d4a-5c89-4d9f-a5c8-b8453af5c280",             "createdDate": "2023-07-15T12:41:27.1363101Z",         },         "success": true,         "statusCode": 202,         "message": "Successfully queued the request"     }
- [Change document protection](https://developer.conga.com/doc-automation/reference/documents_protect2-1.md): Applies or removes protection from the passed document. The generated document can be delivered to one or more destinations.              EXAMPLE I: Apply edit restrictions to a Word document in the Conga Revenue Lifecycle Platform.                  Request:                  POST /documents/420326c7-aaa4-4598-a072-48e8cbbe442d/protect     {         "wordProtectionConfig": {             "RestrictionType": 3,             "restrictionPassword": "Your password goes here"         }     }                  Response:     {         "job": {             "status": 0,             "errorReason": null,             "id": "64d30d4a-5c89-4d9f-a5c8-b8453af5c280",             "createdDate": "2023-07-15T12:41:27.1363101Z",         },         "success": true,         "statusCode": 202,         "message": "Successfully queued the request"     }
- [Convert documents' format](https://developer.conga.com/doc-automation/reference/documents_convert-1.md): Converts one or more passed documents from one format to another. The generated documents can be delivered to one or more destinations.              EXAMPLE I: Convert a batch of Word documents to PDF.                  Request:                  POST /documents/convert     {         "documents": [             {                 "id": "420326c7-aaa4-4598-a072-48e8cbbe442d"             },             {                 "id": "b04393b5-16c2-4364-9ea3-a3d3c38453e1"             }         ],         "outputConfig": {             "outputFormat": 1         }     }                  Response:     {         "job": {             "status": 0,             "errorReason": null,             "id": "64d30d4a-5c89-4d9f-a5c8-b8453af5c280",             "createdDate": "2023-07-15T12:41:27.1363101Z",         },         "success": true,         "statusCode": 202,         "message": "Successfully queued the request"     }
- [Convert a document's format](https://developer.conga.com/doc-automation/reference/documents_convert2-1.md): Converts the passed document from one format to another.	 The generated document can be delivered to one or more destinations.              EXAMPLE I: Convert the passed document to PDF format.                  Request:                  POST /documents/420326c7-aaa4-4598-a072-48e8cbbe442d/convert     {         "outputConfig": {             "outputFormat": 1         }     }                  Response:     {         "job": {             "status": 0,             "errorReason": null,             "id": "64d30d4a-5c89-4d9f-a5c8-b8453af5c280",             "createdDate": "2023-07-15T12:41:27.1363101Z",         },         "success": true,         "statusCode": 202,         "message": "Successfully queued the request"     }
- [/v2/documents/process](https://developer.conga.com/doc-automation/reference/documents_process.md)
- [/v2/documents/{documentId}/process](https://developer.conga.com/doc-automation/reference/documents_process2.md)
- [Get job information](https://developer.conga.com/doc-automation/reference/jobs_get-1.md): Returns information for a given job.              EXAMPLE I: Getting the response information of a completed job.                  Request:                  GET /jobs/64d30d4a-5c89-4d9f-a5c8-b8453af5c280                  Response:                  {         "id": "64d30d4a-5c89-4d9f-a5c8-b8453af5c280",         "status": 3,         "result": {             "Documents": [                 "id": "5042d67f-21e6-4691-8f79-02446d3cd11c",                 "name": "oupput-filename.pdf",                 "entityId": "3ff0e051-d655-451d-abb5-a71b202cb935",                 "entityName": "Agreement",                 "parentDocumentId": "bfc3a050-895e-4d0e-a1a1-777d094082fa",                 "fileType": "application/pdf",                 "fileSize": 181239,                 "extension": ".pdf",                 "createdDate": "2023-07-15T12:42:18.147",                 "modifiedDate": "2023-07-15T12:42:18.147"             ]         }     }
- [Get merge process status](https://developer.conga.com/doc-automation/reference/status_get-1.md): Gets the status of all completed and ongoing merge steps. For more information, see [Conga Composer API Use Cases](https://documentation.conga.com/composer/latest/conga-composer-api-use-cases-203496246.html).
- [Search Salesforce Leads, Contacts and Users](https://developer.conga.com/doc-automation/reference/salesforce_salesforcecontactsleadsusers.md)
- [Get Salesforce Object Name and Object Type by Record ID](https://developer.conga.com/doc-automation/reference/salesforce_getobjecttype.md)
- [Fetch all managed package Salesforce templates (CET + CGT) for the current customer's org.](https://developer.conga.com/doc-automation/reference/salesforce_salesforcetemplates.md)
- [Retrieves recent attachments and files for a Salesforce record(objectId).](https://developer.conga.com/doc-automation/reference/salesforce_getrecentsalesforceattachments.md)
- [Fetch related contacts for a given Salesforce record.](https://developer.conga.com/doc-automation/reference/salesforce_getrelatedcontacts.md)
- [MOCK: Fetch related contacts for a given Salesforce record](https://developer.conga.com/doc-automation/reference/salesforce_mockgetrelatedcontacts.md)
- [Get merge info](https://developer.conga.com/doc-automation/reference/merge_get.md): Gets the merge info.
- [Accept merge](https://developer.conga.com/doc-automation/reference/merge_acceptpreview.md): Once using the DS7Preview flag set to 1, and a user has placed a potential merge job in the preview state, this endpoint, alongside the corresponding correlation ID, can be used to accept said merge while it's in the preview state and proceed with the post merge acitons.
- [Reject merge](https://developer.conga.com/doc-automation/reference/merge_rejectpreview.md): Once using the DS7Preview flag set to 1, and a user has placed a potential merge job in the preview state, this endpoint, alongside the corresponding correlation ID, can be used to reject said merge while it's in the preview state and not proceed with any post merge actions.
- [Initiate the merge workflow](https://developer.conga.com/doc-automation/reference/merge_post.md): Translates the users' merge request inputs into data sets and initiate the merge. For more information, see [Conga Composer API Use Cases.](https://documentation.conga.com/composer/latest/conga-composer-api-use-cases-203496246.html)
- [Initiate the merge workflow after uploading JSON data](https://developer.conga.com/doc-automation/reference/merge_upload.md): Allows the user to upload a json file and initiate the merge request
- [Returns the url list of merged and preview documents for a given correlationId.](https://developer.conga.com/doc-automation/reference/merge_getpreviewfiles.md)
- [Send an email with attachments using providers such as SES, Salesforce (SF), or SendGrid](https://developer.conga.com/doc-automation/reference/email_sendemail.md)
- [MOCK: Send an email with attachments (returns JSON string)](https://developer.conga.com/doc-automation/reference/email_mocksendemail.md)
- [Merge an email template with SF info or JSON payload from original merge request](https://developer.conga.com/doc-automation/reference/email_mergeemailtemplate.md)
- [Generate sign package url](https://developer.conga.com/doc-automation/reference/email_createsignpackage.md)
- [MOCK: Generate sign package url](https://developer.conga.com/doc-automation/reference/email_mockcreatesignpackage.md)
- [Retrieves environment and region details from configuration.](https://developer.conga.com/doc-automation/reference/configuration_getenvironmentandregioninfo.md)
- [Merges the provided dataModel with the template to generate a preview.](https://developer.conga.com/doc-automation/reference/preview_mergetemplate.md)
- [Evaluate PlatformComposer feature flag for the given Salesforce Org Id](https://developer.conga.com/doc-automation/reference/platformcomposerfeatureflag_get.md)
- [/v2/orchestrate/merge](https://developer.conga.com/doc-automation/reference/orchestrate_mergepost.md)
- [/v2/orchestrate/merge](https://developer.conga.com/doc-automation/reference/orchestrate_mergeget.md)
- [Runs the ComposerSolution status migration job.
Finalized records using status "Draft" will be updated to "Complete".](https://developer.conga.com/doc-automation/reference/migration_runmigration.md)
- [Get data Schema JSON](https://developer.conga.com/doc-automation/reference/json_dataschemaprocess.md)
- [/v1/Json/datatranslateprocess](https://developer.conga.com/doc-automation/reference/json_datatranslateprocess.md)
- [Saves a solution draft before it proceeds to the Deploy tab.](https://developer.conga.com/doc-automation/reference/draft_createdraft.md)
- [Retrieves a draft solution by its ID.](https://developer.conga.com/doc-automation/reference/draft_getdraftbyid.md)
- [Retrieves all solutions with optional pagination and search filter.](https://developer.conga.com/doc-automation/reference/solution_getallsolutions.md)
- [Creates a new solution.](https://developer.conga.com/doc-automation/reference/solution_createsolution.md)
- [Retrieves the code snippet for a specific language and solution.](https://developer.conga.com/doc-automation/reference/solution_getsnippet.md)
- [Retrieves a single solution by its ID.](https://developer.conga.com/doc-automation/reference/solution_getsolutionbyid.md)
- [Partially updates an existing solution by its ID (PATCH).](https://developer.conga.com/doc-automation/reference/solution_patchsolution.md)
- [Deletes a solution by its ID.](https://developer.conga.com/doc-automation/reference/solution_deletesolution.md)
- [Get coding languages for the solution's deploy step](https://developer.conga.com/doc-automation/reference/solution_getlanguages.md)
- [Search Saleforce contacts with the given search term.](https://developer.conga.com/doc-automation/reference/solution_salesforcecontacts.md)
- [Uploads a logo file with a custom name.](https://developer.conga.com/doc-automation/reference/custombranding_uploadcustombranding.md)
- [Get all uploaded customBrandings](https://developer.conga.com/doc-automation/reference/custombranding_getallcustombrandings.md)
- [/v1/CustomBranding/{id}](https://developer.conga.com/doc-automation/reference/custombranding_deletecustombranding.md)
- [Updates a logo's image and/or custom name by ID.](https://developer.conga.com/doc-automation/reference/custombranding_updatecustombranding.md)
- [Get logo file details by ID](https://developer.conga.com/doc-automation/reference/custombranding_getcustombrandingbyid.md)
- [/v1/CustomBranding/{id}/download](https://developer.conga.com/doc-automation/reference/custombranding_downloadlogofilebyid.md)
- [Retrieves all parameters with optional pagination and search filter.](https://developer.conga.com/doc-automation/reference/composerparameter_getallparameters.md)
- [/v1/Parameter/{id}](https://developer.conga.com/doc-automation/reference/composerparameter_getparameterbyid.md)
- [Get approval activities for a context object](https://developer.conga.com/doc-automation/reference/activities_getactivities-1.md): Gets all approval activities for a context object.
- [Define an ad hoc process](https://developer.conga.com/doc-automation/reference/adhocprocess_save-1.md): Posts ad hoc process definition and returns the defined process information.
- [Get an ad hoc process](https://developer.conga.com/doc-automation/reference/adhocprocess_getadhocprocessdefinition-1.md): Gets the ad hoc process associated with a given context object type and identifier after it has been saved but before it has been submitted.
- [Delete the adhoc Approvals](https://developer.conga.com/doc-automation/reference/adhocprocess_deleteadhocprocessdefinition-1.md): Delete the adhoc Approvals.
- [Submit adhoc approval](https://developer.conga.com/doc-automation/reference/adhocprocess_submit-1.md): Submits adhoc approval for the given object ID and type.
- [Resubmit an ad hoc process](https://developer.conga.com/doc-automation/reference/adhocprocess_resubmitapproval-1.md): Submits all data from an ad hoc process that has already been submitted.
- [Get a submitted ad hoc process](https://developer.conga.com/doc-automation/reference/adhocprocess_postsubmit-1.md): Gets an ad hoc process definition after it has been submitted.
- [Get Async Operation Status by correlation id](https://developer.conga.com/doc-automation/reference/asyncoperationstatus_getbycorrelationid-1.md): Gets Async Operation Status by correlation id.
- [Get the backup administrator](https://developer.conga.com/doc-automation/reference/backupadmin_getbackupadminuser-1.md): Retrieves details on the currently logged-in user's backup administrator.
- [Save the backup administrator](https://developer.conga.com/doc-automation/reference/backupadmin_upsertbackupadminuser-1.md): Create or update the backup admin user.
- [Delete the backup administrator](https://developer.conga.com/doc-automation/reference/backupadmin_deletebackupadminuser-1.md): Delete the backup admin user.
- [Create or update backup or delegate approvers](https://developer.conga.com/doc-automation/reference/backupdelegates_savebackupdelegates-1.md): Writes (posts) a new backup or delegate approver or updates the information for an existing backup or delegate approver.
- [List backup and delegate approvers](https://developer.conga.com/doc-automation/reference/backupdelegates_search-1.md): Returns a list of backup and delegate approvers.
- [Get a backup or delegate approver](https://developer.conga.com/doc-automation/reference/backupdelegates_getbyid-1.md): Returns a backup or delegate approver by ID.
- [Delete a backup or delegate approver](https://developer.conga.com/doc-automation/reference/backupdelegates_delete-1.md): Delete a backup or delegate approver by ID.
- [Count backup and delegate approvers](https://developer.conga.com/doc-automation/reference/backupdelegates_getactiveinactivecount-1.md): Returns a count of backup and delegate approvers.
- [Activate a backup or delegate](https://developer.conga.com/doc-automation/reference/backupdelegates_activate-1.md): Activates a backup or delegate by record ID.
- [Deactivate a backup or delegate](https://developer.conga.com/doc-automation/reference/backupdelegates_deactivate-1.md): Deactivates a backup or delegate by record ID.
- [List business object types](https://developer.conga.com/doc-automation/reference/businessobjects_getbusinessobjects-1.md): Returns a list of available business object types, such as opportunity, agreement, proposal, product configuration, line item, agreement clause, and agreement line item.
- [List all business objects' assignee type values](https://developer.conga.com/doc-automation/reference/businessobjects_getassigneepicklists-1.md): Lists valid assignee type values for all business objects. Used in the Related User assignee type for a process step as the assignee ID.
- [List a business object's assignee type values](https://developer.conga.com/doc-automation/reference/businessobjects_getassigneepicklistsbybusinessobject-1.md): Lists valid assignee type picklist values for a business object. Used in the the Related User assignee type for a process step as the assignee ID.
- [List a business object's custom user fields](https://developer.conga.com/doc-automation/reference/businessobjects_getcustomuserassigneefields-1.md): Used in the Custom User assignee type for a process step.
- [Validate a custom assignee](https://developer.conga.com/doc-automation/reference/businessobjects_validatecustomuserassigneepayload-1.md): Validates a custom assignee payload for a business object.
- [List a business object's fields](https://developer.conga.com/doc-automation/reference/businessobjects_getfieldsforbusinessobject-1.md): For a given business object, returns field information.
- [Get a business object's child types](https://developer.conga.com/doc-automation/reference/businessobjects_getchildobjecttypes-1.md): Returns a list of available child object types for the named business object.
- [List a business object's processes](https://developer.conga.com/doc-automation/reference/businessobjects_getprocessesforbusinessobject-1.md): Lists a business object's approval processes. If active = true, this returns only active approval processes. If active = false, this returns only inactive approval processes. If active is unset (null), returns all approval processes.
- [Reorder an approval process list](https://developer.conga.com/doc-automation/reference/businessobjects_reorderprocess-1.md): The order of the processes in the payload determines the new sequence after reorder.
- [Get a business object's rules](https://developer.conga.com/doc-automation/reference/businessobjects_getallrulesforbusinessobject-1.md): Returns all business object rules that apply to a named business object.
- [Count all of a business object's rules](https://developer.conga.com/doc-automation/reference/businessobjects_getactiveinactivecount-1.md): For a named business object, returns a count (dictionary object) of its active and inactive keys.
- [List all available email templates](https://developer.conga.com/doc-automation/reference/businessobjects_getemailtemplates.md): Retrieves all available email templates. Use to browse templates for approval notifications and correspondence. Results can be filtered by template name.
- [List email templates for a specific business object type](https://developer.conga.com/doc-automation/reference/businessobjects_getemailtemplatesforbusinessobject.md): Retrieves email templates for a specific business object. Use to find notification templates available for the named object type.
- [List email templates filtered by category](https://developer.conga.com/doc-automation/reference/businessobjects_getemailtemplatesbyemailtemplatecategory.md): Retrieves email templates for a specific category. Use to find templates within a particular email category used in approval processes.
- [List email templates for business object and category](https://developer.conga.com/doc-automation/reference/businessobjects_getemailtemplatesbybusinessobjectandemailtemplatecategory.md): Retrieves email templates for a specific business object and email category. Use to find templates for a named object type within a particular category.
- [Create an approval process](https://developer.conga.com/doc-automation/reference/process_save-1.md): Creates an approval process.
- [Search approval processes](https://developer.conga.com/doc-automation/reference/process_getall-1.md): Searches approval processes by business object name and optional criteria, returning results up to the stated or default limit.
- [Get an approval process](https://developer.conga.com/doc-automation/reference/process_getbyid-1.md): Returns an approval process object by its ID.
- [Update an approval process](https://developer.conga.com/doc-automation/reference/process_updatebyid-1.md): Updates an approval process by its ID.
- [Delete an approval process](https://developer.conga.com/doc-automation/reference/process_deletebyid-1.md): Deletes an approval process by its ID.
- [Activate an approval process](https://developer.conga.com/doc-automation/reference/process_activate-1.md): Activates an approval process by its ID.
- [Deactivate an approval process](https://developer.conga.com/doc-automation/reference/process_deactivate-1.md): Deactivates an approval process by its ID.
- [Clone an approval process](https://developer.conga.com/doc-automation/reference/process_clone-1.md): Clones an approval process by its ID.
- [Reorder a list of approval processes](https://developer.conga.com/doc-automation/reference/process_reorderprocess-1.md): The order of the processes provided in the payload will determine the new sequence after reorder.
- [Get this step's dependencies](https://developer.conga.com/doc-automation/reference/process_getunreferencedstepsbyid-1.md): Retrieves dependencies, by step name, that are available to the current step.
- [List all step dependencies](https://developer.conga.com/doc-automation/reference/process_getdependentsteps-1.md): Retrieves the names of all steps that the given step is dependent on.
- [Update an approval process step by ID](https://developer.conga.com/doc-automation/reference/process_updateprocessstepbyid-1.md): Updates an approval process step by ID, using several required parameters.
- [Delete an approval process step](https://developer.conga.com/doc-automation/reference/process_deleteprocessstepbyid-1.md): Deletes an approval process step by its ID.
- [Reorder approval process steps](https://developer.conga.com/doc-automation/reference/process_reordersteps-1.md): Reorders the steps in an approval process.
- [Get approval process steps](https://developer.conga.com/doc-automation/reference/process_getapprovalprocesssteps-1.md): Retrieves the steps for an approval process.
- [Activate an approval process step](https://developer.conga.com/doc-automation/reference/process_activatestepbyid-1.md): Activates an approval process step, by process and step IDs.
- [Deactivate a process step](https://developer.conga.com/doc-automation/reference/process_deactivatestepbyid-1.md): Deactivates a process step by approval process ID.
- [Check for a process](https://developer.conga.com/doc-automation/reference/process_validate-1.md): Checks for a process by name.
- [Count active and inactive processes](https://developer.conga.com/doc-automation/reference/process_getactiveinactivecount-1.md): Counts a business object's active and inactive processes.
- [Create an approval process step](https://developer.conga.com/doc-automation/reference/processsteps_createapprovalprocessstep-1.md): Creates an approval process step based on several required parameters.
- [Update an approval process step](https://developer.conga.com/doc-automation/reference/processsteps_updateapprovalprocessstep-1.md): Updates an approval process step, using several required parameters.
- [Get an approval process step](https://developer.conga.com/doc-automation/reference/processsteps_getapprovalprocessstep-1.md): Gets an approval process step by process step ID.
- [Check for a step](https://developer.conga.com/doc-automation/reference/processsteps_validateexistingstepname-1.md): Checks for a step by name to validate its uniqueness for the current approval process.
- [Submit for approval](https://developer.conga.com/doc-automation/reference/requests_submit-1.md): Submits an object for approval by checking if any approval process meets the criteria for the given object ID and type.
- [Submit an approval asynchronously](https://developer.conga.com/doc-automation/reference/requests_submit2-1.md): Submit objects for approval asynchronously, checking if any approval process meets the criteria for the given context object ID and type. This asynchronous process allows you to submit many objects for approval.
- [Get an approval request status](https://developer.conga.com/doc-automation/reference/requests_requeststatus-1.md): Gets an approval request status by correlation ID.
- [Preview an approval](https://developer.conga.com/doc-automation/reference/requests_preview-1.md): Previews approvals on an object by checking if any approval process meets the criteria for the given object ID and type.
- [Approve a request](https://developer.conga.com/doc-automation/reference/requests_approve-1.md): Approves the given request and offers the next available approvers, continuing the approval process; otherwise, checks for process completion.
- [Approve requests](https://developer.conga.com/doc-automation/reference/requests_approvemultiple-1.md): Approves the given requests and offers the next available approvers, continuing those approval processes; otherwise, it checks for process completion.
- [Reject an approval request](https://developer.conga.com/doc-automation/reference/requests_reject-1.md): Rejects the given request and offers the next available approvers, continuing the approval process; otherwise, it checks for process completion.
- [Reject approval requests](https://developer.conga.com/doc-automation/reference/requests_rejectmultiple-1.md): Rejects multiple requests.
- [Reassign requests](https://developer.conga.com/doc-automation/reference/requests_reassignmultiple-1.md): Reassigns multiple listed requests.
- [Escalate an approval request](https://developer.conga.com/doc-automation/reference/requests_escalate-1.md): Raises an approval request to level set in escalationTold, configured by the user with the original step or rule.
- [Reassign an approval request](https://developer.conga.com/doc-automation/reference/requests_reassign-1.md): Reassigns an approval request to a new assignee. Provide the new assignee ID, assignee type, and optional comments.
- [Add an ad hoc approver](https://developer.conga.com/doc-automation/reference/requests_addadhocapprovertorulebasedapprovalrequest-1.md): Adds a new approver to the running approval cycle in the position given in the reference step.
- [Delete an ad hoc approver](https://developer.conga.com/doc-automation/reference/requests_deleteadhocapproverfromrulebasedapprovals-1.md): Deletes an ad hoc approver from a rule-based approval.
- [Add comment to approval request](https://developer.conga.com/doc-automation/reference/requests_addcomments-1.md): Adds comments to approval request
- [Reqeust an information about approval request](https://developer.conga.com/doc-automation/reference/requests_addrfi-1.md): Reqeust an information about approval request
- [Check for objects requiring approval](https://developer.conga.com/doc-automation/reference/requests_checkrequired-1.md): Lists business objects and child objects requiring approval.
- [Check for objects requiring approval asynchronously](https://developer.conga.com/doc-automation/reference/requests_checkrequired2-1.md): Lists business objects and child objects requiring approval.
- [Process escalation reminder jobs](https://developer.conga.com/doc-automation/reference/requests_processreminders-1.md): Finds and triggers all reminders and escalations (e.g., sends reminder email, etc.) that are due.
- [Get status for a context object](https://developer.conga.com/doc-automation/reference/requests_getbyobjecttypeandobjectid-1.md): For a given context object type and ID, checks whether the object is in a preview or submitted status.
- [Get status for a context object's child object](https://developer.conga.com/doc-automation/reference/requests_getchildbyobjecttypeandobjectid-1.md): For a given context object type and ID and child object type, checks whether the child object has a Preview or Submitted status.
- [Recall approval requests](https://developer.conga.com/doc-automation/reference/requests_recall-1.md): Recalls (cancels) the current approval cycle and notifies affected approvers and delegates (if any).
- [Get approval request comments](https://developer.conga.com/doc-automation/reference/requests_getcomments-1.md): Gets all comments for an approval request by object type and ID.
- [Bulk business object operations](https://developer.conga.com/doc-automation/reference/requests_bulkprocessmultiplecontextobjects-1.md): Perform the named action types on business objects in bulk operation.
- [Get an approval request](https://developer.conga.com/doc-automation/reference/requests_getrequestbyid-1.md): Gets an approval request by request ID.
- [Get the approval request attachments](https://developer.conga.com/doc-automation/reference/requests_getattachmentsbyrequestids-1.md): Gets attachments by request IDs.
- [Get all requests for an assignee and object](https://developer.conga.com/doc-automation/reference/requests_getrequestsbyassigneeids-1.md): Gets all approval requests for the specified object and assignee.
- [Take ownership of a queued request](https://developer.conga.com/doc-automation/reference/requests_assignrequestowner-1.md): Assigns ownership of a queued approval request to the current user. Use to claim responsibility for processing a request.
- [Get consolidation information for an approval request.](https://developer.conga.com/doc-automation/reference/requests_getrequestconsolidationinfo.md): Retrieves consolidation details, including consolidated requests, for the specified approval request ID.
- [Save an approval rule dimension](https://developer.conga.com/doc-automation/reference/ruledimensions_save-1.md): Writes an approval rule dimension.
- [Get an approval rule dimension](https://developer.conga.com/doc-automation/reference/ruledimensions_getbyid-1.md): Gets an approval rule dimension by ID.
- [Update an approval rule dimension](https://developer.conga.com/doc-automation/reference/ruledimensions_updatebyid-1.md): Updates an approval rule dimension by ID.
- [Delete an approval rule dimension](https://developer.conga.com/doc-automation/reference/ruledimensions_deletebyid-1.md): Deletes an approval rule dimension by ID.
- [Save an approval rule entry](https://developer.conga.com/doc-automation/reference/ruleentries_save-1.md): Writes an approval rule entry and returns the updated approval rule entry definition.
- [Get an approval rule entry](https://developer.conga.com/doc-automation/reference/ruleentries_getbyid-1.md): Gets an approval rule entry by ID.
- [Validate a rule entry label](https://developer.conga.com/doc-automation/reference/ruleentries_validate-1.md): Validates whether a rule entry label is already used.
- [Reorder rule entries](https://developer.conga.com/doc-automation/reference/ruleentries_reorder-1.md): Reorders the list of rule entries (ruleEntries) within a rule to the order given in the request body.
- [Save an approval rule](https://developer.conga.com/doc-automation/reference/rules_save-1.md): Writes an approval rule definition.
- [Search rules](https://developer.conga.com/doc-automation/reference/rules_getall-1.md): Searches rules by name using a filter string.
- [Get an approval rule](https://developer.conga.com/doc-automation/reference/rules_getbyid-1.md): Gets an approval rule by ID.
- [Delete an approval rule](https://developer.conga.com/doc-automation/reference/rules_deletebyid-1.md): Deletes an approval rule by ID.
- [Activate an approval rule](https://developer.conga.com/doc-automation/reference/rules_activate-1.md): Activates an approval rule by ID.
- [Deactivate an approval rule](https://developer.conga.com/doc-automation/reference/rules_deactivate-1.md): Deactivates an approval rule by ID.
- [Clone an approval rule](https://developer.conga.com/doc-automation/reference/rules_clone-1.md): Clone an approval rule by ID.
- [Get rule entry dependencies](https://developer.conga.com/doc-automation/reference/rules_getunreferencedsteps-1.md): Provides rule entries that may be defined as dependencies for the current rule entry.
- [Activate an approval rule entry](https://developer.conga.com/doc-automation/reference/rules_activateruleentrybyid-1.md): Activates an approval rule entry by rule ID and rule entry ID.
- [Deactivate an approval rule entry](https://developer.conga.com/doc-automation/reference/rules_deactivateruleentrybyid-1.md): Deactivates an approval rule entry by rule ID and rule entry ID.
- [Delete an approval rule entry](https://developer.conga.com/doc-automation/reference/rules_deleteruleentrybyid-1.md): Deletes an approval rule entry by rule ID and rule entry ID.
- [Validate a rule name](https://developer.conga.com/doc-automation/reference/rules_validate-1.md): Validates a rule name against existing rule names. Requires a rule name and business object type in the request. Responds with a Boolean (true if name already exists).
- [Create or update a search filter](https://developer.conga.com/doc-automation/reference/searchfilters_save-1.md): Updates a search filter by a given ID. If no ID is passed, creates a new search filter.
- [Get all search filters](https://developer.conga.com/doc-automation/reference/searchfilters_getall-1.md): Retrieves all search filters matched by name using a search string.
- [Get a search filter by ID](https://developer.conga.com/doc-automation/reference/searchfilters_getbyid-1.md): Gets a search filter by its ID.
- [Delete a search filter by ID](https://developer.conga.com/doc-automation/reference/searchfilters_deletebyid-1.md): Deletes a search filter identified by its ID string.
- [Activate a search filter](https://developer.conga.com/doc-automation/reference/searchfilters_activate-1.md): Activates a search filter identified by its ID string.
- [Deactivate a search filter](https://developer.conga.com/doc-automation/reference/searchfilters_deactivate-1.md): Deactivates a search filter identified by its ID string.
- [Validate a search filter name](https://developer.conga.com/doc-automation/reference/searchfilters_validate-1.md): Checks whether a search filter name has already been used. Takes the filter name and business object types as inputs, and returns a Boolean (true if the name already exists and is not available).
- [Get system properties](https://developer.conga.com/doc-automation/reference/systemproperties_getsystemproperties-1.md): Retrieves the system properties.
- [Update system properties](https://developer.conga.com/doc-automation/reference/systemproperties_upsertsystemconfig-1.md): Updates the system properties with a system configuration request.
- [Get a custom configuration](https://developer.conga.com/doc-automation/reference/systemproperties_getcustomconfig-1.md): Retrieves the custom configuration (ProductSettingCustomConfig) for a business object.
- [Delete a custom configuration](https://developer.conga.com/doc-automation/reference/systemproperties_deletecustomconfig-1.md): Deletes the custom configuration (ProductSettingCustomConfig) for a business object.
- [Create or update a custom configuration](https://developer.conga.com/doc-automation/reference/systemproperties_upsertcustomconfig-1.md): Creates or updates the custom configuration (ProductSettingCustomConfig) for a business object.
- [Get custom configurations](https://developer.conga.com/doc-automation/reference/systemproperties_getmultipleproductsettings-1.md): Retrieves custom configurations for multiple business objects.
- [Get Approvals product settings for all business objects](https://developer.conga.com/doc-automation/reference/systemproperties_getallproductsettings-1.md): Retrieves Approvals product settings for all business objects.
- [Get email configuration](https://developer.conga.com/doc-automation/reference/systemproperties_getemailconfig-1.md): Retrieves the email configuration from system properties.
- [Create email configuration](https://developer.conga.com/doc-automation/reference/systemproperties_createemailconfig-1.md): Creates email configuration.
- [Update email configuration](https://developer.conga.com/doc-automation/reference/systemproperties_updateemailconfig-1.md): Updates email configuration.
- [Count user's approvals](https://developer.conga.com/doc-automation/reference/userdashboard_getcount-1.md): Gets the number of approvals for the user.
- [Get Approval Count for BusinessObject](https://developer.conga.com/doc-automation/reference/userdashboard_getdashboardcount-1.md): Get Approval Count for BusinessObject.
- [Get Dashboard count and BusinessObject data or Approval request related to the business object](https://developer.conga.com/doc-automation/reference/userdashboard_getdashboarddata-1.md): Gets approval data for a specified business object, including object metadata, approval counts by status, and optionally the business object records
- [Get user dashboard approval details](https://developer.conga.com/doc-automation/reference/userdashboard_getstatus-1.md): Returns a list of approval requests that match the selected status and filters. It also provides the total number of records for that status.
- [List user groups](https://developer.conga.com/doc-automation/reference/usergroup_getusergroups-1.md): Gets a list of all user groups
- [Create a user group](https://developer.conga.com/doc-automation/reference/usergroup_createusergroup-1.md): Creates a new user group with the provided details. Returns the created user group object with its assigned ID.
- [Update a user group](https://developer.conga.com/doc-automation/reference/usergroup_updateusergroup-1.md): Updates an existing user group with new information. Provide the user group ID and updated fields in the request body. Returns the updated user group object.
- [Get a user group and its members by ID](https://developer.conga.com/doc-automation/reference/usergroup_getusergroupbyid-1.md): Returns the user group (ID, name, email) with all members. Each member contains: ID, name, type (User or Group), member ID, and group ID.
- [Delete a user group by ID](https://developer.conga.com/doc-automation/reference/usergroup_deleteusergroupbyid-1.md): Deletes the user group.
- [List user group members](https://developer.conga.com/doc-automation/reference/usergroup_getusergroupmembers-1.md): Lists all members of the given user group.
- [Add a member](https://developer.conga.com/doc-automation/reference/usergroup_addusergroupmember-1.md): Adds a member to an existing user group.
- [Delete a member by ID](https://developer.conga.com/doc-automation/reference/usergroup_deleteusergroupmemberbyid-1.md): Deletes the user group member identified in the request.
- [Get Adobe sign events by esign transaction](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-adobe-transactionid-audittrail-1.md): Retrieves list of events from Adobe based on the transaction ID provided in the parameters. The transaction ID is the esign ID generated during envelope creation.
             This API returns events details as the agreement events happened during transaction, from esign transaction id will get the external id which is agreement id in Adobe.
- [Retrieves a list of agreement signing cycles based on the specified signing provider type and agreement ID.](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-agreement-agreementid-signing-cycle-1.md)
- [Get refresh token](https://developer.conga.com/doc-automation/reference/post_api-esign-v1-authorize-refresh-1.md): Gets a refresh token using an authentication code.
- [Get access token](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-authorize-token-1.md): Retrieves an access token for an eSignature service provider.
- [Get sign configuration](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-configuration-1.md): Retrieves the sign configuration for the specified provider type.
- [Update the sign configuration](https://developer.conga.com/doc-automation/reference/put_api-esign-v1-esignatures-configuration-1.md): Saves or updates the sign configuration and returns either consentUrl (for Docusign and AdobeSign) or a success message (for Conga Sign).
- [Set the default sign provider](https://developer.conga.com/doc-automation/reference/post_api-esign-v1-esignatures-configuration-default-1.md): Sets the specified sign provider as the default for all new eSignature transactions.
- [Activate a sign provider](https://developer.conga.com/doc-automation/reference/post_api-esign-v1-esignatures-configuration-activate-1.md): Activates the specified sign provider type, allowing it to be used for eSignature operations.
- [Create and send a transaction](https://developer.conga.com/doc-automation/reference/post_api-esign-v1-congasign-send-1.md): Creates a package for Conga Sign
             You can use the package ID to get such transaction details as envelope status, signed date, and declined reason. 
             You can use the tag URL to open the document inside the Conga Sign console, add signature tags and additional fields, and send the document to Conga Sign.
- [Create an envelope](https://developer.conga.com/doc-automation/reference/post_api-esign-v1-esignatures-1.md): Creates an envelope for DocuSign, an agreement for Adobe Sign, or a package for Conga Sign based on the eSignature service provider in the signProviderType parameter. 
             You can use the package ID to get such transaction details as envelope status, signed date, and declined reason. 
             You can use the tag URL to open the document inside the eSignature service provider console, add signature tags and additional fields, and send the document for eSignature.
- [Get transaction details by transaction](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-transactionid-1.md): Retrieves transaction details based on the transaction ID provided in the parameters. The transaction ID is the package ID obtained during envelope creation.
             This API returns such transaction details as the envelope status, the dates the envelope was sent and signed, and, if the recipient declined, their reason for declining.
- [Get transaction details by object ID](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-transactionbyobjectid-objectid-1.md): Retrieves transaction details based on the object ID. Use the same object ID used to create the envelope.
- [List allowed signer types](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-signertypes-1.md): Retrieves the allowed signer types for a given eSignature service provider. When creating the envelope, the signer type is provided in the Role field.
- [List users](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-usersearch-searchstring-1.md): Retrieves a list of users based on the given user and contact object search criteria. In the search text, provide the user name or letters from the user name.
- [End wet-sign flow](https://developer.conga.com/doc-automation/reference/post_api-esign-v1-esignatures-wetsign-transactionid-end-1.md): Marks the given transactionId's wet-sign flow as ended and uploads the given document as a signed document.
- [Get sign provider templates](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-templates-1.md): Retrieves a list of templates from the specified eSignature service provider.
- [/api/esign/v1/esignatures/void/{objectId}](https://developer.conga.com/doc-automation/reference/post_api-esign-v1-esignatures-void-objectid-1.md)
- [Get the latest sign provider](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-transaction-objectid-latestsigntransaction-1.md): Retrieves the latest eSign transaction sign provider for the specified object ID.
- [Get event logs by package ID](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-eventlogs-packageid.md): Retrieves all event logs from the ESignEventLogsFromListener table for the specified package ID.
- [Get all event logs with pagination](https://developer.conga.com/doc-automation/reference/get_api-esign-v1-esignatures-eventlogs.md): Retrieves all event logs from the ESignEventLogsFromListener table with pagination support. 
             Use 'from' and 'to' as 1-based record numbers (e.g., from=1, to=25 returns the first 25 records).
- [Retrieves a list of blacklisted attachment types.](https://developer.conga.com/doc-automation/reference/accountattachmentsblacklist_getaccountattachmentsblacklist.md): An attachment blacklist is a list of file types that a signer cannot upload to a transaction.  For example, .exe files may be blacklisted, meaning that a signer cannot attach an .exe file  to the transaction.  Returns a list of blocked file extensions (e.g., "EXE", "DLL", "MSI", "DMG", "SO").  Note: This endpoint is READ-ONLY. The blacklist is managed by OneSpan system administrators  and cannot be modified via the API.
- [Retrieves your current attachments whitelist.](https://developer.conga.com/doc-automation/reference/accountattachmentswhitelist_getaccountattachmentswhitelist.md): Retrieves your attachments whitelist. The whitelist defines which file types are allowed  as attachments in signing ceremonies.  Returns a list of allowed file extensions (e.g., "PDF", "TXT", "JPG", "DOC").
- [Updates your attachments whitelist.](https://developer.conga.com/doc-automation/reference/accountattachmentswhitelist_updateaccountattachmentswhitelist.md): Updates your attachments whitelist. This defines which file types are allowed as attachments.  Provide a list of file extensions (e.g., ["PDF", "TXT", "JPG", "DOC", "DOCX"]).  Note: This endpoint uses PUT (full replacement), not PATCH (partial update). All file types must be specified; any types not included will be removed from the whitelist.
- [Deletes and resets attachments whitelist.](https://developer.conga.com/doc-automation/reference/accountattachmentswhitelist_deleteaccountattachmentswhitelist.md): Deletes attachments whitelist that you may have configured.  Your attachments whitelist will be returned to their default values.  After deletion, the system will revert to OneSpan's default allowed file types.
- [Retrieves your current Designer settings. Retrieved values include any customizations you may have made, as well as any current default values.](https://developer.conga.com/doc-automation/reference/accountdesignersettings_getaccountdesignersettings-1.md): Retrieves your current Designer settings
- [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.](https://developer.conga.com/doc-automation/reference/accountdesignersettings_updateaccountdesignersettings-1.md): Updates your Designer settings
- [Deletes any Designer settings that you may have configured. Your Designer settings will be returned to their default values.](https://developer.conga.com/doc-automation/reference/accountdesignersettings_deleteaccountdesignersettings-1.md): Deletes customized Designer settings
- [Retrieves your current Email Reminder settings.](https://developer.conga.com/doc-automation/reference/accountemailremindersettings_getemailremindersettings-1.md): Retrieves your current Email Reminder settings. This includes the amount of time to wait before sending the first email reminder (startInDaysDelay), the amount of time to wait before sending any subsequent reminders (intervalInDays), and the total number of reminders to be sent (repetitionsCount).
- [Updates your account email reminder settings.](https://developer.conga.com/doc-automation/reference/accountemailremindersettings_updateemailremindersettings-1.md): Updates your email reminder settings. This includes the amount of time to wait before sending the first email reminder(startInDaysDelay), the amount of time to wait before sending any subsequent reminders (intervalInDays), and the total number of reminders to be sent(repetitionsCount).
- [Deletes any customized Account Email Reminder settings.](https://developer.conga.com/doc-automation/reference/accountemailremindersettings_deleteemailremindersettings-1.md): Deletes any account email reminder settings that you may have configured and returns them to the default value of 0 (zero). When set to 0, no email reminders will be sent.
- [Retrieves a list of all your current Backoffice Feature settings.](https://developer.conga.com/doc-automation/reference/accountfeaturesettings_getaccountfeaturesettings-1.md): Retrieves your Backoffice Feature settings. These settings are used to enable or disable features in the Backoffice.
- [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.](https://developer.conga.com/doc-automation/reference/accountfeaturesettings_patchaccountfeaturesettings-1.md): Update your Backoffice Feature settings with your new settings.
- [Deletes and resets any customized Backoffice Feature settings.](https://developer.conga.com/doc-automation/reference/accountfeaturesettings_deleteaccountfeaturesettings-1.md): Deletes any Backoffice Feature settings that you may have changed. Your Backoffice Feature settings will be returned to their default values.
- [Retrieves a list of all your current Backoffice Package Settings](https://developer.conga.com/doc-automation/reference/accountpackagesettings_getaccountpackagesettings-1.md): Retrieves your Backoffice Package settings
- [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](https://developer.conga.com/doc-automation/reference/accountpackagesettings_addaccountpackagesettings-1.md): Update your Backoffice Package settings with your new settings
- [Deletes and resets any customized Backoffice Package settings](https://developer.conga.com/doc-automation/reference/accountpackagesettings_deleteaccountpackagesettings-1.md): Deletes any Backoffice Package settings that you may have changed. Your Backoffice Package settings will be returned to their default values
- [Retrieve account role information](https://developer.conga.com/doc-automation/reference/accountroles_listroles-1.md): Retrieves account role information, such as name and permissions, for the current system account. Using this call requires roles and permissions to be enabled on your account. To enable roles and permissions, contact your Conga Sign sales representative.
- [Create a new account role](https://developer.conga.com/doc-automation/reference/accountroles_createaccountrole-1.md): Adds an account role to an account. Using this call requires roles and permissions to be enabled on your account. To enable roles and permissions, contact your Conga Sign sales representative.
- [Update an account role](https://developer.conga.com/doc-automation/reference/accountroles_updateaccountrole-1.md): Updates an account role, for example, to change permission settings or a role name. Using this call requires roles and permissions to be enabled on your account. To enable roles and permissions, contact your Conga Sign sales representative.
- [Retrieve an account role](https://developer.conga.com/doc-automation/reference/accountroles_getaccountrole-1.md): Retrieves an account role using the specified ID. Using this call requires roles and permissions to be enabled on your account. To enable roles and permissions, contact your Conga Sign sales representative.
- [Delete an account role](https://developer.conga.com/doc-automation/reference/accountroles_deleteaccountrole-1.md): Deletes an account role using the specified ID. Using this call requires roles and permissions to be enabled on your account. To enable roles and permissions contact your Conga Sign sales representative.
- [Retrieve user IDs assigned to a role](https://developer.conga.com/doc-automation/reference/accountroles_getaccountusers-1.md): Retrieves the list of user IDs assigned to a given role. Using this call requires roles and permissions to be enabled on your account. To enable roles and permissions contact your Conga Sign sales representative.
- [Get the user's account roles](https://developer.conga.com/doc-automation/reference/accountroles_getuseraccountroles-1.md): Retrieves the account roles assigned to the specified user. If the subaccount feature is enabled, the API retrieves all specified or user-assigned subaccount roles if accountId is provided. Using this call requires roles and permissions to be enabled on your account.  To enable roles and permissions, contact your Conga Sign sales representative.
- [Create a new account role](https://developer.conga.com/doc-automation/reference/accountroles_assignaccountroletouser-1.md): Adds an account role to an account. Using this call requires roles and permissions to be enabled on your account.  To enable Roles and Permissions, contact your Conga Sign sales representative.
- [Retrieve account usage information](https://developer.conga.com/doc-automation/reference/accounts_getaccountusage.md): Retrieves usage information for the current account.
- [Retrieves a list of all your current Backoffice Account settings.](https://developer.conga.com/doc-automation/reference/accountsettings_getaccountsettings.md): Retrieves your Backoffice Account settings. This includes feature settings, package settings, designer settings, email reminder settings, and signing UI options.
- [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.](https://developer.conga.com/doc-automation/reference/accountsettings_updateaccountsettings.md): Update your Backoffice Account settings with your new settings. You can update one or more setting groups (feature settings, package settings, designer settings, etc.) in a single request.
- [Deletes and resets any customized Backoffice Account settings.](https://developer.conga.com/doc-automation/reference/accountsettings_deleteaccountsettings.md): Deletes any Backoffice Account settings that you may have changed. Your Backoffice Account settings will be returned to their default values.
- [Add, update, or delete signing ceremony logos](https://developer.conga.com/doc-automation/reference/accountsigninglogos_getaccountsigninglogos-1.md): Retrieves an account's customized logo for use during the signing ceremony. In addition, the corresponding language for the account is retrieved.
- [Retrieve an account's signing ceremony logos](https://developer.conga.com/doc-automation/reference/accountsigninglogos_createaccountsigninglogos-1.md): Adds, updates or deletes an account's customized signing ceremony logos. To add or update a signing ceremony logo for a language, pass the base-64 decoded image (data URI) with the language. To delete all signing ceremony logos, provide an empty {} request body.              Note that 1. The image has to be one of the following formats - jpeg, png, gif, bmp or svg. 2. The maximum supported size for an image is 1MB 3. The recommended dimensions for a Signing Ceremony logo is 258px X 40 px.
- [Retrieve a customized signing theme](https://developer.conga.com/doc-automation/reference/accountsigningtheme_getsigningtheme-1.md): Retrieves a customized signing theme so that it can be used. A customized signing theme is a signing theme that was designed by your organization using, for example, your corporate branding.
- [Create a customized signing theme](https://developer.conga.com/doc-automation/reference/accountsigningtheme_createsigningtheme-1.md): Creates a signing theme defined by your settings. A customized signing theme is a signing theme designed by your organization using, for example, your corporate branding.              Sample request:                  POST /cs-account/signingThemes     {       "default": {         "color": {           "signatureButton": "#CAEA19",           "error": "#3B48B5",           "signatureSticky": "#5940C3",           "warning": "#BE5718",           "primary": "#CAEA19",           "optionalSignatureButton": "#CAEA19",           "info": "#2E74B2",           "success": "#1B7445"         }       }     }
- [Update a customized signing theme](https://developer.conga.com/doc-automation/reference/accountsigningtheme_updatesigningtheme-1.md): Creates a signing theme defined by your settings. A customized signing theme is a signing theme designed by your organization using, for example, your corporate branding.              Sample request:                  PUT /cs-account/signingThemes     {       "default": {         "color": {           "signatureButton": "#CAEA19",           "error": "#3B48B5",           "signatureSticky": "#5940C3",           "warning": "#BE5718",           "primary": "#CAEA19",           "optionalSignatureButton": "#CAEA19",           "info": "#2E74B2",           "success": "#1B7445"         }       }     }
- [Delete customized signing themes](https://developer.conga.com/doc-automation/reference/accountsigningtheme_deletesigningtheme-1.md): Deletes a customized signing theme. A customized signing theme is a signing theme that was designed by your organization using, for example, your corporate branding.
- [Retrieve customized new signer experience settings](https://developer.conga.com/doc-automation/reference/accountsigninguioptions_getaccountsigninguioptions-1.md): Retrieves customized New Signer Experience settings. Note that if there are no customized settings for the New Signer Experience then the default settings for the New Signer Experience will be returned.
- [Patch custom signing UI options](https://developer.conga.com/doc-automation/reference/accountsigninguioptions_patchaccountsigninguioptions-1.md): Retrieves the customized Signing UI Options.
- [Delete customized new signer experience settings](https://developer.conga.com/doc-automation/reference/accountsigninguioptions_deleteaccountsigninguioptions-1.md): Deletes customized New Signer Experience settings. Note that if there are no customized settings for the New Signer Experience then the default settings for the New Signer Experience will be returned.
- [Retrieves the list of supported languages that you can set for your signers.](https://developer.conga.com/doc-automation/reference/accountsupportedlanguages_getaccountsupportedlanguages.md): Retrieves a list of languages that you have defined as being available for use by your signers  in any transaction that you send. This includes the default signing language set by you.
- [Updates your supported signing languages.](https://developer.conga.com/doc-automation/reference/accountsupportedlanguages_updateaccountsupportedlanguages.md): Defines or updates the default language to be used by your signers, and defines the list of  supported signer languages that can be used instead of the default one.
- [Deletes your personally configured supported signing language settings.](https://developer.conga.com/doc-automation/reference/accountsupportedlanguages_deleteaccountsupportedlanguages.md): Deletes any signing language settings that you may have configured for your account.  This includes the list of languages that can be used when signing a transaction,  and the default language to be used by your signers in any transaction that you send.
- [Retrieves your current system settings.](https://developer.conga.com/doc-automation/reference/accountsystemsettings_getaccountsystemsettings.md): Retrieves your system settings. These settings control system-level configurations  such as session timeouts, transaction lifetimes, and authentication settings.
- [Update your system settings with new settings.](https://developer.conga.com/doc-automation/reference/accountsystemsettings_updateaccountsystemsettings.md): Updates your account system 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.
- [Deletes and resets any customized system settings.](https://developer.conga.com/doc-automation/reference/accountsystemsettings_deleteaccountsystemsettings.md): Deletes any system settings that you may have changed. Your system settings  will be returned to their default values.
- [Create an approval](https://developer.conga.com/doc-automation/reference/approval_createapproval-1.md): Creates a new approval for a package or document. Note that text anchor extraction cannot be used in this API call.
- [Update an approval](https://developer.conga.com/doc-automation/reference/approval_updateapprovals-1.md): Updates the existing approval requests on a package or a document.
- [Retrieve an approval](https://developer.conga.com/doc-automation/reference/approval_getapproval-1.md): Retrieves an approval for the identified package or document.
- [Update an approval](https://developer.conga.com/doc-automation/reference/approval_updateapproval-1.md): Updates a specific approval created for a package or a document.
- [Delete an existing approval](https://developer.conga.com/doc-automation/reference/approval_deleteapproval-1.md): Deletes a specific approval that already exists for a package or document.
- [Create a new field with an autogenerated name related to an existing approval](https://developer.conga.com/doc-automation/reference/approval_createapprovalfield-1.md): Creates a new field for an existing approval. The new field is created with an autogenerated name.
- [Retrieve an approval field](https://developer.conga.com/doc-automation/reference/approval_getapprovalfield-1.md): Retrieves a field that exists on an already created approval.
- [Update a field related to an approval](https://developer.conga.com/doc-automation/reference/approval_updateapprovalfield-1.md): Updates an existing field related to an existing approval. Note that the JSON Field ID will be ignored and replaced by the one from the query parameter.
- [Create a field related to an approval with a specific field ID](https://developer.conga.com/doc-automation/reference/approval_createapprovalfieldbyid.md): Creates a new field that can then be added to an existing approval.  Note: There is a known behavior where this endpoint may function similarly to PUT (update). This may be legacy behavior on OneSpan's side. Use with caution and verify behavior.
- [Delete a field from an approval.](https://developer.conga.com/doc-automation/reference/approval_deletefieldbyid-1.md): Deletes a field added to an existing approval.
- [Updates the conditions for a given approval field](https://developer.conga.com/doc-automation/reference/approval_updateconditionalfields.md): Updates the conditions for a given field. In addition to the array of conditions,  the payload should contain all Field properties. The value of the field is replaced by this payload.  Conditional fields allow you to show/hide or enable/disable fields based on the values  of other fields in the document.  Example use case: Show "Company Name" field only if user selects "Business" in the "Account Type" field.
- [Retrieve all signable approvals](https://developer.conga.com/doc-automation/reference/approval_getsignerapproval-1.md): Retrieves all approvals that are eligible for signature.
- [Create a sender authentication token](https://developer.conga.com/doc-automation/reference/authenticationtokens_createsenderauthtoken-1.md): Creates a token that can be used to obtain a valid session for the owner of an existing package, so they can edit the package using the Designer view, and then distribute it for signing. The destination must be a valid destination for a sender and is restricted to a particular package. It is single-use and expires after 30 minutes (this is configurable). This token allows you to log in using a Get to the ?senderDesignerToken=VALUE or ?senderTransactionEditToken=VALUE
- [Create a multi-use signer authentication token](https://developer.conga.com/doc-automation/reference/authenticationtokens_createmultiusesignerauthtoken-1.md): Creates a token that can be used to obtain a valid session for a particular signer of an existing package, so they can sign the package. This single-use token is restricted to a single package and expires after 30 minutes (this is configurable); however, it can be used multiple times. This token allows you to log in using a Get to the %2Fauth?senderAuthenticationToken=VALUE%26target=http://environment/destination. The destination must be a valid destination for a signer.
- [Create a new single use signer authentication token](https://developer.conga.com/doc-automation/reference/authenticationtokens_createsingleusesignerauthtoken-1.md): Creates a token that can be used to obtain a valid session for a particular signer of an existing package so they can sign the package. This single-use token is restricted to a single package and expires after 30 minutes (this is configurable). This token allows you to log in through a Get to the %2Fauth?senderAuthenticationToken=VALUE%26target=http://environment/destination. The destination must be a valid destination for a signer.
- [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.](https://developer.conga.com/doc-automation/reference/authenticationtokens_getuserauthtoken-1.md)
- [Retrieves a list of all callbacks.](https://developer.conga.com/doc-automation/reference/callback_getcallback-1.md): Callback event notifications allow you to be automatically notified of events pertaining to a package. Upon a specific event, the system will automatically call a specified URL.
- [Creates a new callback.](https://developer.conga.com/doc-automation/reference/callback_addcallback-1.md): Callback event notifications allow you to be automatically notified of events pertaining to a package. Upon a specific event, the system will automatically call a specified URL.
- [Retrieves a list of callbacks for a specified connector.](https://developer.conga.com/doc-automation/reference/callback_getconnectorcallback-1.md): Retrieves a list of callbacks for a specified connector, such as a SalesforceOauth2 connector, or a Microsoft CRM connector. <br>Accepted values for Origin: <br> dynamics <br> sharepoint <br> dynamics2011 <br> dynamics2013 <br> dynamics2015 <br> sharepoint2010 <br> sharepoint2013 <br> salesforceOauth2 <br> Note that, when using the origin "salesforceOauth2", the key field of the Callback object has a specific format. <br> The base64 encoded string for the following JSON structure is expected in the key field. <br> { <br>  &nbsp;&nbsp;host: [salesforce oauth host], <br>  &nbsp;&nbsp;client_id: [salesforce connected app client id] <br>  &nbsp;&nbsp;refresh_token: [salesforce connected app refresh token], <br> } <br> This is an example of a valid JSON structure for the key field: <br> { <br> &nbsp;&nbsp;host: [salesforce oauth host], <br> &nbsp;&nbsp;client_id: [salesforce connected app client id] <br> &nbsp;&nbsp;refresh_token: [salesforce connected app refresh token], <br> } <br> The base64 encoded string for the JSON example above would be (disregarding linebreaks): <br> [base64 encoded string for the JSON structure above]
- [Creates a new callback for a specified connector.](https://developer.conga.com/doc-automation/reference/callback_addconnectorcallback-1.md): Creates a new callback for a specified connector, such as a SalesforceOauth2 connector, or a Microsoft CRM connector. <br>Accepted values for Origin: <br> dynamics <br> sharepoint <br> dynamics2011 <br> dynamics2013 <br> dynamics2015 <br> sharepoint2010 <br> sharepoint2013 <br> salesforceOauth2 <br> Note that, when using the origin "salesforceOauth2", the key field of the Callback object has a specific format. <br> The base64 encoded string for the following JSON structure is expected in the key field. <br> { <br>  &nbsp;&nbsp;host: [salesforce oauth host], <br>  &nbsp;&nbsp;client_id: [salesforce connected app client id] <br>  &nbsp;&nbsp;refresh_token: [salesforce connected app refresh token], <br> } <br> This is an example of a valid JSON structure for the key field: <br> { <br> &nbsp;&nbsp;host: [salesforce oauth host], <br> &nbsp;&nbsp;client_id: [salesforce connected app client id] <br> &nbsp;&nbsp;refresh_token: [salesforce connected app refresh token], <br> } <br> The base64 encoded string for the JSON example above would be (disregarding linebreaks): <br> [base64 encoded string for the JSON structure above]
- [Checks for comprehensive health](https://developer.conga.com/doc-automation/reference/comprehensivehealthcheck_checkcomprehensivehealth.md)
- [Get Customer Onboarded](https://developer.conga.com/doc-automation/reference/customeronboarded_get-1.md)
- [CONGA-ONLY
Delete OneSpanCallback Customer Registration](https://developer.conga.com/doc-automation/reference/customerregistration_delete-1.md)
- [CONGA-ONLY
Register OneSpanCallback Customer Information](https://developer.conga.com/doc-automation/reference/customerregistration_post-1.md)
- [CONGA-ONLY
Get OneSpanCallback Customer Information](https://developer.conga.com/doc-automation/reference/customerregistration_get.md)
- [Create a custom field](https://developer.conga.com/doc-automation/reference/customfields_createcustomfield-1.md)
- [List all custom fields. Query parameters "to" and "from" are expected to navigate pages.](https://developer.conga.com/doc-automation/reference/customfields_listcustomfields-1.md)
- [Update a custom field](https://developer.conga.com/doc-automation/reference/customfields_updatecustomfield-1.md)
- [Delete a custom account field by ID](https://developer.conga.com/doc-automation/reference/customfields_deletecustomfield-1.md)
- [Retrieve an account specified custom field](https://developer.conga.com/doc-automation/reference/customfields_getcustomfield-1.md)
- [Retrieve the data management policy for the account](https://developer.conga.com/doc-automation/reference/datamanagement_getdatamanagementpolicy-1.md): Retrieves the data management policy for the account.
- [Update the account's data management policy](https://developer.conga.com/doc-automation/reference/datamanagement_updatedatamanagementpolicy-1.md): Updates data management policy for the account.
- [Retrieve the expiry configurations defined for the account](https://developer.conga.com/doc-automation/reference/datamanagement_getexpirytimeconfiguration-1.md): Retrieves the expiry configurations defined for the account. A value of 0 indicates unlimited.
- [Update the expiry configurations defined for the account](https://developer.conga.com/doc-automation/reference/datamanagement_updateexpirytimeconfiguration-1.md): Updates the expiry configurations defined for the account. For unlimited data retention, assign the “Expiry date” the value 0.
- [Retrieve the specified document](https://developer.conga.com/doc-automation/reference/documents_getdocument-1.md): Retrieves all information related to a given document, including ID, name, description, presentation index, any associated data elements, approvals and fields.
- [Update a document](https://developer.conga.com/doc-automation/reference/documents_updatedocument-1.md): Updates a single, specified document. This endpoint accepts multi-part data, or the JSON structure of a document.
- [Update the specified document](https://developer.conga.com/doc-automation/reference/documents_updatedocumentput-1.md): Updates the specified document.
- [Delete a document from a package](https://developer.conga.com/doc-automation/reference/documents_deletedocument-1.md): Deletes a document from a specified package.
- [Retrieve zipped documents](https://developer.conga.com/doc-automation/reference/documents_getzip-1.md): Retrieves a zipped file that contains all documents that were added to the package.
- [Retrieve document visibility information](https://developer.conga.com/doc-automation/reference/documents_getdocumentvisibility-1.md): Retrieves information about which recipients can view specific documents in a package during a Signing Ceremony.
- [Update document visibility](https://developer.conga.com/doc-automation/reference/documents_updatedocumentsvisibility-1.md): Retrieves information about which recipients can view specific documents in a package during a Signing Ceremony. The response is a Document Visibility object that contains a list of configurations. Each configuration has: (1) the Document ID of a specific document; (2) a list of Role IDs of the signers who can view the document. Note that: Documents not in the Document Visibility object are visible to all recipients. The Package Owner can always see all documents in the package, regardless of its Document Visibility configuration.
- [Retrieve an original PDF document](https://developer.conga.com/doc-automation/reference/documents_getoriginaldocument-1.md): Retrieves the original PDF document that was included in a package.
- [Retrieve a specific document in PDF form](https://developer.conga.com/doc-automation/reference/documents_getpdfdocument-1.md): Retrieves a specific document. This function always returns the PDF version of the document, even if the document was originally submitted in a different format.
- [Retrieve a page](https://developer.conga.com/doc-automation/reference/documents_getdocumentpagebyindex-1.md): Retrieves the document page you specify, returning it as a .png image file.
- [Add a new document to an existing package](https://developer.conga.com/doc-automation/reference/documents_createdocument-1.md): Adds a new document to an existing package by using a document resource.
- [Update documents](https://developer.conga.com/doc-automation/reference/documents_updatedocuments-1.md): Updates the documents in a package. For example, to re-order them.
- [Delete multiple documents from a package](https://developer.conga.com/doc-automation/reference/documents_deletedocuments-1.md): Deletes multiple documents, identified by their documentID, from a specified package.
- [Create a signature confirmation](https://developer.conga.com/doc-automation/reference/documents_createsignatureconfirmation-1.md): Confirms that the application can execute the signing process on the document.
- [Sign all documents in a package](https://developer.conga.com/doc-automation/reference/documents_signalldocuments-1.md): Signs all documents in a specified package.
- [Apply a layout to a document](https://developer.conga.com/doc-automation/reference/documents_applylayouttodocument-1.md): Applies a specific layout to a specified document. At least one parameter needs to be applied, either layoutID, or layoutName.
- [Retrieve zipped file containing all documents including supporting documents](https://developer.conga.com/doc-automation/reference/documents_getalldocumentszip.md): Retrieves a zipped file that contains both signable documents and Supporting Documents. This differs from the /zip endpoint which only returns signable documents.
- [Replace approvals and imprint fields for a document](https://developer.conga.com/doc-automation/reference/documents_replacedocumentfields.md): Replaces approvals and imprint fields with those provided in the request. - If an array is not provided then nothing will be updated for that field type. - If an empty array is provided then all fields of that type will be deleted. - Only the editable imprint fields will be replaced.
- [Update document custom metadata](https://developer.conga.com/doc-automation/reference/documents_updatedocumentmetadata.md): Updates the document custom metadata by overriding it with those in the payload. Internal metadata defined by OneSpan cannot be updated and will be ignored if included in the payload.  Metadata is stored as key-value pairs where keys are strings and values can be any JSON-serializable type.
- [Retrieve external authentication options](https://developer.conga.com/doc-automation/reference/externalauthentication_getexternalauthenticationoptions.md): Retrieves the external authentication options configured for the current account, including available SSO providers and authentication methods.
- [Download all attachments](https://developer.conga.com/doc-automation/reference/fileattachment_getzipattachment-1.md): Compresses all attachments into a zip file, which is then downloaded.
- [Download all attachments for a specific role](https://developer.conga.com/doc-automation/reference/fileattachment_getzipattachmentbyrole-1.md): Compresses all attachments into a zip file and then downloads it. Only attachments for the specified role are included.
- [Download an attachment](https://developer.conga.com/doc-automation/reference/fileattachment_getattachmentbyid-1.md): Downloads the specified attachment.
- [Add an attachment](https://developer.conga.com/doc-automation/reference/fileattachment_addattachment-1.md): Uploads an attachment to the specified package.
- [Delete an attachment file](https://developer.conga.com/doc-automation/reference/fileattachment_deleteattachmentfile-1.md): Deletes specific attachment file.
- [Download an attachment](https://developer.conga.com/doc-automation/reference/fileattachment_getattachmentfile-1.md): Downloads a specified attachment from a package.
- [Check for a specific attachment](https://developer.conga.com/doc-automation/reference/fileattachment_checkattachmentfileexists-1.md): Checks whether or not the specified attachment exists in the package.
- [Check for signer uploads](https://developer.conga.com/doc-automation/reference/fileattachment_checkattachmentexists-1.md): Verifies whether or not the specified attachment contains any uploads from the Signer.
- [Check for attachments and uploads by role](https://developer.conga.com/doc-automation/reference/fileattachment_checkzipattachmentbyroleexists-1.md): Verifies whether or not there are any attachments for the specified role, and whether or not those attachments contain uploads from a Signer.
- [Get IDV evidence summary](https://developer.conga.com/doc-automation/reference/idvevidencesummary_getidvevidencesummary.md): Retrieves IDV Evidence Summary in Json format when package id is provided.
- [Get IDV evidence summary image URLs](https://developer.conga.com/doc-automation/reference/idvevidencesummary_getidvevidencesummaryimages.md): Gets a list of image in Detailed Verification Report when package id is provided.
- [Get IDV evidence summary signer image](https://developer.conga.com/doc-automation/reference/idvevidencesummary_getidvevidencesummarysignerimage.md): Downloads selected IDV image in binary format when package id, idv transaction id and image urls are provided.
- [Retrieve the IDV authentication workflow](https://developer.conga.com/doc-automation/reference/idvworkflow_getidvworkflowconfigs-1.md): Retrieves the IDV workflow configurations as JSON. The IDV workflow configuration is the secure agreement automation workflow that integrates with Conga Sign. This must be set in the back office.
- [Create an IDV authentication workflow configuration](https://developer.conga.com/doc-automation/reference/idvworkflow_createidvworkflowconfigs-1.md): Creates a workflow configuration for IDV authentication. The following types of workflow configurations can be created: DV and DVF. The IDV workflow configuration is the secure agreement automation workflow that integrates with Conga Sign. This must be set in the back office.
- [Update IDV workflow configuration](https://developer.conga.com/doc-automation/reference/idvworkflow_updateidvworkflowconfigs-1.md): Updates the IDV workflow configuration. The IDV workflow configuration is the secure agreement automation workflow that integrates with Conga Sign. This must be set in the back office.
- [Delete  IDV workflow configuration](https://developer.conga.com/doc-automation/reference/idvworkflow_deleteidvworkflowconfigs-1.md): Deletes the IDV workflow configuration. The IDV workflow configuration is the secure agreement automation workflow that integrates with Conga Sign. This must be set in the back office.
- [Retrieve IF workflow configuration information](https://developer.conga.com/doc-automation/reference/ifworkflowconfiguration_getifworkflowconfiguration.md): Retrieves IF workflow configuration information for the current account.
- [Creates new imprint field with an autogenerated id.](https://developer.conga.com/doc-automation/reference/imprintfields_postimprintfield.md): Creates new imprint field with an autogenerated id.
- [Deletes all imprint fields assigned to the document.](https://developer.conga.com/doc-automation/reference/imprintfields_deleteimprintfields.md): Deletes all imprint fields assigned to the document.
- [Replaces all imprint fields with those provided in the request.](https://developer.conga.com/doc-automation/reference/imprintfields_updateimprintfields.md): Replaces all imprint fields with those provided in the request. If an empty array is provided then all fields will be deleted. Only the editable imprint fields will be replaced.
- [Retrieves existing imprint field.](https://developer.conga.com/doc-automation/reference/imprintfields_getexistingimprintfield.md): Retrieves existing imprint field.
- [Deletes existing imprint field.](https://developer.conga.com/doc-automation/reference/imprintfields_deleteimprintfields2.md): Deletes existing imprint field.
- [Update existing imprint field.](https://developer.conga.com/doc-automation/reference/imprintfields_updateexistingimprintfield.md): Updates existing imprint field. Note that the JSON Field ID will be ignored and replaced by the one from the query parameter.
- [Copies the imprint field to the other documents in the package.](https://developer.conga.com/doc-automation/reference/imprintfields_imprintfieldcopies.md): Copies the imprint field to the other documents in the package. When it is not possible to add a field due to the lack of a given page number, the field will be added on the last page of this document.
- [Retrieve reports by date and type](https://developer.conga.com/doc-automation/reference/inappreports_getallinappreports-1.md): Retrieves reports for the specified dates and report type for all accounts.
- [Delete the specified report files (csv)](https://developer.conga.com/doc-automation/reference/inappreports_deleteallinappreports-1.md): Deletes the specified report files (csv).
- [Retrieve report summaries by date and report type](https://developer.conga.com/doc-automation/reference/inappreports_getallinappreportsummaries-1.md): Retrieves report summaries for the specified dates and report type for all accounts.
- [Retrieve a report file (csv)](https://developer.conga.com/doc-automation/reference/inappreports_getinappreportbyid-1.md): Retrieves the specified report file (csv).
- [Delete a report file by ID (csv)](https://developer.conga.com/doc-automation/reference/inappreports_deleteinappreportbyid-1.md): Deletes the specified report file by ID (csv).
- [Retrieve zipped csv reports](https://developer.conga.com/doc-automation/reference/inappreports_getinappreportaszip-1.md): Retrieves the specified report files (csv) as a zip file.
- [List available layouts](https://developer.conga.com/doc-automation/reference/layout_getlayouts-1.md): Retrieves a list of available layouts, which you can filter and sort. By default, this call returns the API caller's layouts. When specifying either the ownerUserId or ownerEmail query parameter, this call returns the specified user's layouts. To retrieve other users' layouts, you must have enabled the roles and permissions feature on your account and the API caller must have the "Manage users’ transactions, templates, and layouts" permission. To enable roles and permissions, contact your Conga Sign sales representative.
- [Create a new layout](https://developer.conga.com/doc-automation/reference/layout_createlayout-1.md): Creates a new layout.
- [Re-send a notification to a signer](https://developer.conga.com/doc-automation/reference/notification_resendsmscodeforsigner-1.md): Resends a notification to a signer.
- [Re-send a notification to a signer](https://developer.conga.com/doc-automation/reference/notification_resendnotificationsforpackage-1.md): Resends a notification to a signer.
- [Send an SMS notification to signers linked to a role](https://developer.conga.com/doc-automation/reference/notification_resendnotificationsforpackageandrole-1.md): Sends an SMS notification to the signers linked to a role.
- [Send an SMS notification to signers linked to a role](https://developer.conga.com/doc-automation/reference/notification_resendsmsnotificationsforpackageandrole-1.md): Sends an SMS notification to the signers linked to a role.
- [Send mobile notification](https://developer.conga.com/doc-automation/reference/notification_resendmobilenotificationsforpackagedocumentapproval-1.md): Sends a notification to yourself. Included in the notification is a mobile-device signing link to an approval.
- [List all OAuth2 clients](https://developer.conga.com/doc-automation/reference/oauth2_listoauth2clients.md): Retrieves a list of all OAuth2 clients associated with the authenticated account. This endpoint returns basic information about each OAuth2 client, including the account UID, client alias, client ID, and creation timestamp. The client secret is not included in the response for security reasons.
- [Create a new OAuth2 client](https://developer.conga.com/doc-automation/reference/oauth2_createoauth2client.md): Creates a new OAuth2 client for the authenticated account. The client will be assigned a unique client ID and client secret that can be used for OAuth2 authentication flows. The client secret is only returned in this response and when regenerating credentials, so it should be stored securely.
- [Delete an OAuth2 client](https://developer.conga.com/doc-automation/reference/oauth2_deleteoauth2client.md): Permanently deletes an OAuth2 client from the authenticated account. Once deleted, the client ID and secret will no longer be valid for authentication. This action cannot be undone. Any existing access tokens generated by this client will be immediately invalidated.
- [Regenerate OAuth2 client secret](https://developer.conga.com/doc-automation/reference/oauth2_regenerateoauth2clientsecret.md): Generates a new client secret for an existing OAuth2 client. The old client secret will be immediately invalidated and any existing access tokens generated with the old secret will be revoked. The new client secret is only returned in this response, so it should be stored securely. This operation is useful for security rotation or when the client secret has been compromised.
- [Generate an OAuth2 access token](https://developer.conga.com/doc-automation/reference/oauth2_generateoauth2token.md): Standard OAuth2 token endpoint for obtaining access tokens using the client credentials grant flow. This endpoint is used to exchange OAuth2 client credentials for an access token that can be used to authenticate API requests. The client credentials should be provided in the request body as form-urlencoded data with client_id, client_secret, and grant_type.
- [List packages](https://developer.conga.com/doc-automation/reference/onespanpackage_listpackages-1.md): Retrieves a list of document packages in an account. By default, this call returns the API caller's packages. When either the ownerUserId or ownerEmail query parameter is specified, this call returns the specified user's transactions. To retrieve other users' transactions, roles and permissions must be enabled on your account and the API caller must have "Manage users’ transactions, templates, layouts" permission. To enable roles and permissions, contact your Conga Sign sales representative.
- [Retrieves OneSpan BaseURL for different regions](https://developer.conga.com/doc-automation/reference/onespanurl_get-1.md): Retrieves OneSpan BaseURL for different regions
- [List packages](https://developer.conga.com/doc-automation/reference/package_listpackages-1.md): Retrieves a list of document packages in an account. By default, this call returns the API caller's packages. When either the ownerUserId or ownerEmail query parameter is specified, this call returns the specified user's transactions. To retrieve other users' transactions, roles and permissions must be enabled on your account and the API caller must have "Manage users’ transactions, templates, layouts" permission. To enable roles and permissions, contact your Conga Sign sales representative.
- [Create a package](https://developer.conga.com/doc-automation/reference/package_createpackage-1.md): Creates a new package or a template with no attachments. To create a template, set Type to Template. To create a package with attachments, see "Create a package with attachments".
- [Get package information](https://developer.conga.com/doc-automation/reference/package_getpackagebyid-1.md): Retrieves information about a document package.
- [Update a package](https://developer.conga.com/doc-automation/reference/package_updatepackage-1.md): Updates the information pertaining to a specified package.
- [Delete a package](https://developer.conga.com/doc-automation/reference/package_deletepackagebyid-1.md): Deletes a specified package or template.
- [Get package readiness](https://developer.conga.com/doc-automation/reference/package_getpackagereadiness-1.md): Retrieves a package's readiness to be sent for signature. This API returns a True status when the package is ready to send.
- [Get package audit details](https://developer.conga.com/doc-automation/reference/package_getpackageaudit-1.md): Retrieves a package's audit details. The audit trail is embedded directly in the package and can be viewed any time.
- [Summarize package evidence](https://developer.conga.com/doc-automation/reference/package_getpackageevidencesummary-1.md): Retrieves summary evidence information for a specified package.
- [List package fields](https://developer.conga.com/doc-automation/reference/package_getpackagefieldsummary-1.md): Retrieves a list of form fields in a package. Fields are grouped by document and by signer.
- [/v1/cs-packages/{packageId}/referencedConditions](https://developer.conga.com/doc-automation/reference/package_getpackagereferencedconditions-1.md)
- [Retrieve all approvals by signer](https://developer.conga.com/doc-automation/reference/package_getpackagesignerapprovals-1.md): Retrieves all approvals for a specified signer in a specific package.
- [Get package signing status](https://developer.conga.com/doc-automation/reference/package_getpackagesigningstatus-1.md): Retrieves the signing status of a package. Retrieved information can be filtered by signer or by document.
- [Get package signature URL](https://developer.conga.com/doc-automation/reference/package_getsigningurlbyroleid-1.md): Retrieves the URL that a signer can use to sign a package. This can only be done to a package that is not modifiable (e.g., a sent package). It cannot be done to a package in a draft state.
- [Create packages](https://developer.conga.com/doc-automation/reference/package_createpackagesusingbulksend-1.md): Create and send packages using bulk send. The package ID must be of type template.              **Prerequisites** * Enable the bulk send feature in your account. * Create an eligible template. A template is considered eligible if it contains at least one document that is not the consent agreement, placeholder role, and signature field. * Create a CSV file with recipient details. The file must include placeholder, first name, last name, and email columns.              This API returns a bulk send batch ID.
- [Re-create a package or template](https://developer.conga.com/doc-automation/reference/package_createpackageclone-1.md): Creates a package or template from an existing package or template. To create a template, set type in the request body to "TEMPLATE".
- [Retrieve password policy information](https://developer.conga.com/doc-automation/reference/passwordpolicy_getpasswordpolicy.md): Retrieves the password policy configuration for the current account.
- [Update password policy configuration](https://developer.conga.com/doc-automation/reference/passwordpolicy_updatepasswordpolicy.md): Updates the password policy configuration for the current account.
- [Retrieve a package's reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_getreminders-1.md): Retrieves the reminder schedule of a package. A reminder schedule for the package must already exist.
- [Create a reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_createreminders-1.md): The user can only create a reminder schedule on packages that are not yet sent. All reminders are created automatically by the system when a package is sent.
- [Update a reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_updatereminders-1.md): Updates the specified package's reminder schedule. This resource is not available for packages whose status is SENT.
- [Delete a reminder schedule](https://developer.conga.com/doc-automation/reference/reminder_deletereminders-1.md): Deletes the reminder schedule of the specified package.
- [Report this sender's usage](https://developer.conga.com/doc-automation/reference/reports_getusagereport-1.md): Retrieves a usage report for the sender currently logged into the account.
- [Report completions by sender](https://developer.conga.com/doc-automation/reference/reports_getcompletionreport-1.md): Retrieves a completion report for the specified sender.
- [Report senders' usage for this account](https://developer.conga.com/doc-automation/reference/reports_getsendertransactionsummaryreport-1.md): Retrieves a paginated usage report for the sender currently logged into the account.
- [Retrieve a usage report of transactions](https://developer.conga.com/doc-automation/reference/reports_gettransactionsummaryreport-1.md): Retrieves a paginated usage report for the current account.
- [Report transaction details for transactionId](https://developer.conga.com/doc-automation/reference/reports_gettransactiondetailreportbyid-1.md): Retrieves a transaction details report for a specified transaction ID.
- [Report current sender's usage](https://developer.conga.com/doc-automation/reference/reports_getdelegationreport-1.md): Retrieves a usage report for the sender currently logged into the account.
- [Retrieve all package roles](https://developer.conga.com/doc-automation/reference/role_listroles-1.md): Retrieves all roles for the package.
- [Add new role](https://developer.conga.com/doc-automation/reference/role_createrole-1.md): Adds a new role to an existing package.
- [Reorder package roles](https://developer.conga.com/doc-automation/reference/role_reorderroles-1.md): Reorders the roles in a specified package.
- [Adds a new ad hoc group to a transaction](https://developer.conga.com/doc-automation/reference/role_createadhocgroup.md): Adds a new ad hoc group and its members to an existing transaction.  An ad hoc group allows multiple signers to be grouped together, where only one member  needs to sign on behalf of the entire group.  The request body must be an array of Role objects: 1. Individual member roles (regular signers) - these become potential group members 2. The ad hoc group role with a special signer that has:    - signerType: "AD_HOC_GROUP_SIGNER"    - group.members: Array referencing the member role IDs  Example structure: [   {     "signers": [{ "firstName": "John", "lastName": "Doe", "email": "john@example.com" }],     "id": "member-role-id-1"   },   {     "signers": [{ "firstName": "Jane", "lastName": "Smith", "email": "jane@example.com" }],     "id": "member-role-id-2"   },   {     "id": "ad-hoc-group-role-id",     "signers": [{       "firstName": "Legal Review Group",       "signerType": "AD_HOC_GROUP_SIGNER",       "group": {         "members": [           { "userId": "member-role-id-1", "memberType": "AD_HOC_GROUP_MEMBER" },           { "userId": "member-role-id-2", "memberType": "SIGNER" }         ]       }     }]   } ]
- [Updates a transaction's existing ad hoc group](https://developer.conga.com/doc-automation/reference/role_updateadhocgroup.md): Updates an existing ad hoc group, for a specified transaction, including any changes  to the group's members.  The request body structure is the same as creation: - Array of member Role objects (existing or new members) - The ad hoc group Role object with updated configuration  You can: - Add new members by including their roles in the array - Remove members by excluding them from the group.members array - Update the group name via the signer's firstName - Modify member types (AD_HOC_GROUP_MEMBER vs SIGNER)  Member types: - AD_HOC_GROUP_MEMBER: Must sign if selected - SIGNER: Optional member (can be selected to sign)
- [Deletes a specified ad hoc group](https://developer.conga.com/doc-automation/reference/role_deleteadhocgroup.md): Deletes a specified ad hoc group from a transaction.  This will remove: - The ad hoc group role - All member roles that were created for this group  Note: If member roles are used elsewhere in the package, they may not be deleted.
- [Retrieve a role](https://developer.conga.com/doc-automation/reference/role_getrole-1.md): Retrieves a single role associated with a package.
- [Update roles in the package](https://developer.conga.com/doc-automation/reference/role_updaterole-1.md): Updates a single Role by overriding its existing values with those in the JSON payload.
- [Delete a role](https://developer.conga.com/doc-automation/reference/role_deleterole-1.md): Deletes a specified role.
- [Unlock a role](https://developer.conga.com/doc-automation/reference/role_unlockrole-1.md): Unlocks a specified role.
- [Retrieve information on verification types being used](https://developer.conga.com/doc-automation/reference/rolesverification_getroleverification-1.md): If an advanced form of verification is used, such as an external verification method, then this call retrieves information about that verification method for the specified role.
- [Update an advanced verification method](https://developer.conga.com/doc-automation/reference/rolesverification_updateroleverification-1.md): Updates an existing advanced form of verification, such as an external verification method, for the specified role.
- [Create advanced verification](https://developer.conga.com/doc-automation/reference/rolesverification_createroleverification-1.md): Creates an advanced form of verification for a role, such as an external verification method role.
- [Delete an advanced verification method](https://developer.conga.com/doc-automation/reference/rolesverification_deleteroleverification-1.md): If an advanced form of verification is used, such as an external verification method, then this call deletes that verification method for the specified role.
- [Retrieve advanced verification types](https://developer.conga.com/doc-automation/reference/rolesverification_getaccountverificationtypes-1.md): Retrieves a list of verification types that are available in the account.
- [List users in an account](https://developer.conga.com/doc-automation/reference/sender_listsenders-1.md): Retrieves a list of the users in an account. Optional query parameters can be used to filter the list. By default, only one sender is retrieved. To retrieve additional users you must modify the "to" and "from" parameters, where each number in the parameter corresponds to a user. For example: to = 3 from = 10 Will return users 3 to 10 in the user list.
- [Create a user](https://developer.conga.com/doc-automation/reference/sender_createsender-1.md): Creates a new user in an account.
- [Retrieve a user's detailed account information](https://developer.conga.com/doc-automation/reference/sender_getsender-1.md): Retrieves detailed account information of a specified user.
- [Update a sender's details](https://developer.conga.com/doc-automation/reference/sender_updatesender-1.md): Updates or modifies detail information for a specified Sender.
- [Delete a sender](https://developer.conga.com/doc-automation/reference/sender_deletesender-1.md): Deletes a specified sender from an account.
- [Invites a user to join the account.](https://developer.conga.com/doc-automation/reference/sender_invitesender.md): Sends an email invitation to a user. The user will receive an invitation link  and a token identifying the account.  Note: OneSpan returns 200 OK with empty body, which is automatically converted  to 204 No Content by the response handler.
- [Updates a Sender's password.](https://developer.conga.com/doc-automation/reference/sender_updatepassword.md): Helps users update or change their account password. Users can only modify their own password.
- [Resets the password for a specified user.](https://developer.conga.com/doc-automation/reference/sender_resetpassword-1.md): Sends an email to a specified user, so that they can set a new password.
- [Retrieve a user's signature](https://developer.conga.com/doc-automation/reference/sender_getsenderssignatureimage-1.md): Retrieves the image that is being used by a recipient as their default signature when signing a transaction.
- [Upload a signature image](https://developer.conga.com/doc-automation/reference/sender_uploadsendersignatureimage-1.md): Uploads an image to be used by a recipient as their default signature when signing a transaction.
- [Delete a signature image](https://developer.conga.com/doc-automation/reference/sender_deletesendersignatureimage-1.md): Deletes the image being used by a recipient as their default transaction signature.
- [Retrieve session object](https://developer.conga.com/doc-automation/reference/session_getsession-1.md): Retrieves the session object.
- [Retrieve signature image for a package role](https://developer.conga.com/doc-automation/reference/signatureimage_getsignatureimage.md): Retrieves the signature image for a specific role within a package.
- [Retrieve signature layout configuration](https://developer.conga.com/doc-automation/reference/signaturelayout_getsignaturelayout.md): Retrieves the current signature layout configuration for the account, including logo and capture layout settings.
- [Update signature layout configuration](https://developer.conga.com/doc-automation/reference/signaturelayout_updatesignaturelayout.md): Updates the signature layout configuration for the account, including logo image and capture layout settings.
- [List sub-accounts](https://developer.conga.com/doc-automation/reference/subaccounts_listaccessiblesubaccounts-1.md): Sub-accounts enable an organization to create child accounts within its             master account. For example, an organization might want to create child accounts on the basis of its departments,             geographical locations, or lines of business. Accounts can be created on three levels (parent > child > grandchild),             enabling an organization to manage many account types under its master account.
- [List API keys for the current sub-account user](https://developer.conga.com/doc-automation/reference/subaccounts_listsubaccountapikeys-1.md): Retrieves a list of API keys for the current user in the sub-accounts. This current user must have             user management, sub-account management and API access permissions in a different sub-account to get an API key.
- [List sub-accounts](https://developer.conga.com/doc-automation/reference/subaccounts_listsubaccounts-1.md): Retrieves a list of accounts that are sub-accounts of the current account.
- [Create a new sub-account](https://developer.conga.com/doc-automation/reference/subaccounts_createsubaccount-1.md): Sub-accounts enable an organization to create child accounts within the organization's master account.             For example, an organization might want to create child accounts on the basis of its departments, geographical             locations, or lines of business. Accounts can be created on three levels, parent, child, grandchild.             This enables an organization to manage many account types under its master account.
- [Update a sub-account](https://developer.conga.com/doc-automation/reference/subaccounts_updatesubaccount-1.md): Updates a sub-account with information specified in the parameters.
- [Retrieve a virtual room configuration](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroomconfig-1.md): Virtual rooms give you the ability to support your business using remote and online tools. Virtual rooms allow you to help your signers complete their transactions with the same level of support that they would get from a face to face interaction. This call allows you to retreive the configurations of a virtual room that has been created for a specific transaction.
- [Update a virtual room configuration](https://developer.conga.com/doc-automation/reference/virtualroom_putvirtualroomconfig-1.md): Update the configuration of virtual room for specific package.
- [List masked fields](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroommaskedfields-1.md): In a virtual-room transaction, returns a list of field ID's that are masked. These fields cannot be seen by other signers in the Virtual Room transaction.              Returns a list of fields in following format: {documentId}-{approvalId}-{fieldId}.
- [Define fields to be masked](https://developer.conga.com/doc-automation/reference/virtualroom_postvirtualroommaskedfields-1.md): In a Virtual Room transaction, returns a list of field id's that are masked. This means that these fields cannot be seen by other signers in the Virtual Room transaction.              Returns a list of fields in following format: {documentId}-{approvalId}-{fieldId}.
- [Add a masked field](https://developer.conga.com/doc-automation/reference/virtualroom_putvirtualroommaskedfieldsbyid-1.md): Adds a field to a list of masked fields in a Virtual Room transaction.
- [Delete a masked field](https://developer.conga.com/doc-automation/reference/virtualroom_deletevirtualroommaskedfieldsbyid-1.md): In a Virtual Room transaction, deletes a specified field from a list of other masked fields.
- [List available virtual room recordings](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroomrecording-1.md): Retrieves a list of available virtual room session recordings for a given package.
- [Fetch a video file](https://developer.conga.com/doc-automation/reference/virtualroom_getvirtualroomrecordingbyid-1.md): Fetches a video file by recording ID.

## Changelog
- [Welcome to Conga Approvals](https://developer.conga.com/doc-automation/changelog/welcome-to-conga-approvals.md)


# Contracts Documentation

> CLM, X-Author for Contracts, and Contract Intelligence

## API Reference
- [Get contract hierarchy for an account using query](https://developer.conga.com/contracts/reference/post_api-clm-v1-accounts-accountid-contracts-hierarchy-query.md)
- [Get hierarchy starting from a specific contract under an account](https://developer.conga.com/contracts/reference/get_api-clm-v1-accounts-accountid-contracts-contractid-hierarchy.md)
- [Get hierarchy starting from a specific contract under an account](https://developer.conga.com/contracts/reference/post_api-clm-v1-accounts-accountid-contracts-contractid-hierarchy-query.md)
- [Get a document requirement setting by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-contract-type-requirements-id.md): Fetches a single document requirement setting record.
- [Query document requirement settings](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-contract-type-requirements-query.md): Retrieves document requirement settings based on query parameters such as Limit, Skip, Sort, GroupBy, etc.
- [Query document requirement settings by contract type and action](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-contract-type-requirements.md): Retrieves document requirement settings filtered by a specific contract type and action.
- [Update document requirement settings](https://developer.conga.com/contracts/reference/put_api-clm-v1-settings-documents-contract-type-requirements.md): Updates existing document requirement settings records. Each record must include an Id field.
- [Get thread records](https://developer.conga.com/contracts/reference/post_api-clm-v1-conversation-threads-query.md): Returns thread records matching the query request.
- [Search conversation threads](https://developer.conga.com/contracts/reference/post_api-clm-v1-conversation-threads-search.md): Searches conversation threads by keyword across subjects, message content, participant names, and optionally document names.
 
 **Required Parameters**:
 - `searchText`: Keyword to search for
 - `objectType`: Object type (e.g., "Agreement")
 - `objectId`: Specific object ID to search threads for
 
 **Search Scope**:
 - Thread subject/name (exact and partial matches)
 - Message content across all messages in threads
 - Participant names (both internal Users and external Contacts)
 - Document names (when `searchInAttachments` is true)
 
 **Example Request** (Search across Agreement and amendments):
 ```json
 {
   "searchText": "contract review",
   "objectType": "Agreement",
   "objectId": "CON-12345",
   "searchInAttachments": true,
   "sortBy": "ModifiedDate",
   "sortDirection": "Descending",
   "limit": 10,
   "skip": 0
 }
 ```
- [Get activated contracts with obligations](https://developer.conga.com/contracts/reference/post_api-clm-v1-obligations-activated-contracts-1.md): Fetches contracts that have status as "Activated" with their associated obligations.
- [End wet signature flow](https://developer.conga.com/contracts/reference/post_api-clm-v1-sign-esignatures-wetsign-transactionid-end-1.md): Ends a wet signature flow by its ID and attaches the given signed document with the contract.
- [Find template records](https://developer.conga.com/contracts/reference/post_api-clm-v1-templates-query-1.md): Fetches template records that match a query.
- [Get activity history records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-activityhistory-query-1.md): Fetches activity history records.
- [Create a bulk import job](https://developer.conga.com/contracts/reference/post_api-clm-v1-import-jobs-1.md): The API allows you to upload .CSV files and import bulk data into Conga CLM. You can upload accounts, contacts, and agreements in bulk by creating and uploading a .CSV file. This creates a record for the file, which is assigned a queued status. The conga-contracts-batch-worker verifies the data and skips invalid data records. It creates records for the valid records in CLM. You can review failure reasons by accessing the .CSV file at the specified endpoint (/api/clm/v1/import/jobs/{jobId}).
- [List bulk import jobs](https://developer.conga.com/contracts/reference/post_api-clm-v1-import-jobs-query-1.md): Retrieves all bulk import job records.
- [Get bulk import job result](https://developer.conga.com/contracts/reference/get_api-clm-v1-import-jobs-jobid-1.md): Gets the result (failure or success) for a given job.
- [Delete a bulk import job](https://developer.conga.com/contracts/reference/delete_api-clm-v1-import-jobs-jobid-1.md): Permanently deletes record of the given job ID from the system.
- [Get uploaded file details](https://developer.conga.com/contracts/reference/get_api-clm-v1-import-jobs-jobid-batch-batchid-1.md): Fetches contents of the file uploaded for bulk data creation based on jobID and batchID.
- [Get bulk import templates](https://developer.conga.com/contracts/reference/get_api-clm-v1-import-templates-format-1.md): The API fetches bulk import templates for the provided objectName and format. Templates are required for uploading .CSV files to import bulk data into Conga CLM. A template comprises columns corresponding to the database fields required for inserting data for the data type. A distinct template is provided to create .CSV files to upload the Account, Contact, and Agreement data types.
- [Create a clause obligation request](https://developer.conga.com/contracts/reference/post_api-clm-v1-clauses-clauseid-obligations-1.md): Creates a clause obligation record in CLM. Makes Obligation entry in Master Obligation and makes entry of Clause Id and Obligation Id in Clause Obligation table.
 The required fields to create a clause obligation record are: 
 * Name   
 You can introduce these additional fields to the clause obligation.
 * ObligationType 
 * Priority 
 * Description
- [Delete clause obligations](https://developer.conga.com/contracts/reference/delete_api-clm-v1-clauses-clauseid-obligations-1.md): Deletes clause obligations based on the provided clause obligation IDs for the specified clause ID.
 
 If clause obligation IDs are not provided, all clause obligations associated with the provided clause ID are deleted.
- [Get all clause obligations](https://developer.conga.com/contracts/reference/post_api-clm-v1-clauses-clauseid-obligations-query-1.md): Fetches all clause obligations with respect to clause Id. 
 You can filter and sort the results by defining query parameters.
- [Get a clause obligation by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-clauses-clauseid-obligations-obligationid-1.md): Fetches a clause obligation by its ID.
- [Update a clause obligation](https://developer.conga.com/contracts/reference/put_api-clm-v1-clauses-clauseid-obligations-obligationid-1.md): Updates a clause obligation record.
- [Delete a clause obligation by ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-clauses-clauseid-obligations-obligationid-1.md): Deletes a clause obligation by its ID.
- [Get configuration](https://developer.conga.com/contracts/reference/get_api-clm-v1-configurations-category-category-name-name.md): Fetches CLM configuration settings by category and name. All CLM-related configurations are available in the CLM category.
- [Create a contract record](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-1.md): Creates a contract record in CLM. Name and Record Type are the required fields to create a contract. 
 
 CLM auto-populates the system fields, such as Status Category and Status fields, which help identify the current stage of the contract lifecycle.
 
 The Status Category and Status fields are set to "Requested". The logged-in user is added to the RecordOwner field by default. 
 
 You can introduce these additional and custom fields to the contract.
 * Name 
 * Account 
 * RecordType 
 * RecordOwner 
 * Status 
 * StatusCategory 
 * Id 
 * CreatedBy 
 * CreatedDate 
 * ModifiedBy 
 * ModifiedDate 
 * ExternalId 
 * ActivatedBy 
 * ActivatedDate 
 * ContractCategory 
 * ContractNumber 
 * AmendmentEffectiveDate 
 * AutoRenewConsent 
 * AutoRenewTermMonths 
 * AutoRenewalTerms 
 * AutoRenewal 
 * ContractEndDate 
 * ContractNumber 
 * ContractStartDate 
 * Description 
 * InitiationType 
 * InternalRenewalNotificationDays 
 * InternalRenewalStartDate 
 * ParentContract 
 * Perpetual 
 * PrimaryContact 
 * Opportunity 
 * RemainingContractedDays 
 * RenewalNoticeDate 
 * RenewalNoticeDays 
 * RetentionDate 
 * RetentionPolicyId 
 * Source 
 * SpecialTerms 
 * SubmitRequestMode 
 * TermMonths 
 * TerminationComments 
 * TerminationDate 
 * TerminationNoticeDays 
 * TerminationNoticeIssueDate 
 * TermType 
 * TotalContractValue 
 * ExecutedDate 
 * Currency
- [Delete contracts](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-1.md): Permanently deletes the contract records of the provided contract IDs from the system.
- [Update a contract record](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-1.md): Updates a contract record in CLM. The Name and Record Type fields are required update a contract.
 
 You can also update the contract with these additional and custom fields. 
 
 * Name
 * Account
 * RecordType
 * RecordOwner
 * Status
 * StatusCategory
 * Id
 * CreatedBy
 * CreatedDate
 * ModifiedBy
 * ModifiedDate
 * ExternalId
 
 * ActivatedBy
 * ActivatedDate
 * ContractCategory
 * ContractNumber
 * AmendmentEffectiveDate
 * AutoRenewConsent
 * AutoRenewTermMonths
 * AutoRenewalTerms
 * AutoRenewal
 * ContractEndDate
 * ContractNumber
 * ContractStartDate
 * Description
 * InitiationType
 * InternalRenewalNotificationDays
 * InternalRenewalStartDate
 * ParentContract
 * Perpetual
 * PrimaryContact
 * Opportunity
 * RemainingContractedDays
 * RenewalNoticeDate
 * RenewalNoticeDays
 * RetentionDate
 * RetentionPolicyId
 * Source
 * SpecialTerms
 * SubmitRequestMode
 * TermMonths
 * TerminationComments
 * TerminationDate
 * TerminationNoticeDays
 * TerminationNoticeIssueDate
 * TermType
 * TotalContractValue
 * ExecutedDate
 * Currency
- [Get a contract's details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-1.md): Fetches contract details of the provided contract ID. The API returns values of all contract fields including any configured custom fields.
- [Delete a contract](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-1.md): Permanently deletes the record of the provided contract ID from the system.
- [Update a contract's signature status](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-signstatus-1.md): Updates a contract's signature status (signed, declined, or out for signature). For consumption by the eSign Service API.
- [Get contract records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-query-1.md): Returns contract records matching the query request. Contracts created from contract requests are included in the result only if their contract status is "Request". Contracts with an "In Progress" or "Canceled" contract status are not included in the result.
- [Get contract clause details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-clauses-contractclauseid-1.md): Fetches contract clause details based on contract clause ID.
- [Get all contract clauses](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clauses-1.md): Fetches all contract clauses and groups them by Clause and DocumentVersionId fields. This API also processes the contract clauses to return the most recent version of each clause along with the total number of versions for each clause.
 You can filter and sort the results by defining query parameters.
- [Create a new contract clause](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clause-1.md): Creates a new contract clause for the specified contract.
- [Update an existing contract clause](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-clause-contractclauseid-1.md): Updates a contract clause with the provided data.
- [Delete a contract clause](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-clauses-contractclauseid-1.md): Deletes the specified clause from the contract.
- [Create multiple clauses for a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clauses-bulk-1.md): Creates multiple clauses for the specified contract in a single request.
- [Update multiple clauses of a contract](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-clauses-bulk-1.md): Updates multiple clauses of a contract with the provided data in a single request. Each clause in the request must include an ID field.
- [Delete multiple contract clauses](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-clauses-bulk-1.md): Deletes multiple clauses associated with the specified contract in a single request.
- [Get a cycle-time group record by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-cycletimes-cycletimegroupid-1.md): Gets a record from a cycle-time group object by its ID.
- [Update a cycle-time group record](https://developer.conga.com/contracts/reference/put_api-clm-v1-cycletimes-cycletimegroupid-1.md): Updates a record in a cycle-time group object.
- [Delete a cycle-time group record](https://developer.conga.com/contracts/reference/delete_api-clm-v1-cycletimes-cycletimegroupid-1.md): Deletes a record from a cycle-time group object.
- [List all of a contract's or contract object's fields](https://developer.conga.com/contracts/reference/get_api-clm-v1-cycletimes-contractfields-1.md): Fetches a contract or contract object using metadata that can be used in a cycle-time group record.
- [Create a cycle-time group record](https://developer.conga.com/contracts/reference/post_api-clm-v1-cycletimes-1.md): Creates a record in a cycle-time group object.
- [Get cycle-time group data](https://developer.conga.com/contracts/reference/get_api-clm-v1-cycletimes-dashboard-1.md): Gets cycle-time group data for the predefined out-of-the-box status category and status for the past 12 months.
- [Create a new contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-1.md): Creates a new contract document for the provided contract ID. 
 
 On success, the contract status changes to "Author Contract" if the contract's previous status was "Request".
- [Delete documents by contract ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-documents-1.md): Deletes one or more documents associated with a specific contract. You can provide a list of document IDs to delete specific documents, or omit the list to delete all documents linked to the contract. The API permanently removes the document data while retaining the metadata with the "IsDeleted" flag set to true. The API returns a confirmation of the deletion status.
- [Get document details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-documents-documentid-1.md): Fetches document details for the provided document ID.
- [Update a contract](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-documents-documentid-1.md): Updates the contract document for the provided document ID. 
 
 This API creates a new version ID with the same document ID and retains the previous version.
- [Query contract documents](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-query-1.md): Executes a query request against document records, returning matching records.
- [Query contract documents for status and version](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-querywithreview-1.md): Executes a query request against the document records and returns matching records with review status and document versions.
- [Get document by ID and version](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-documents-documentid-versions-documentmetadataid-1.md): Fetches document details for the provided document ID and version ID.
- [Delete document versions](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-documents-documentid-versions-1.md): Deletes documents based on provided document version IDs for a specified contract ID.
 
 This API permanently deletes the document data but document metadata is retained in the system with the "IsDeleted" flag set to true.
- [Get a contract's related documents](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-documents-relateddocuments-1.md): Fetches all related documents for the provided contract ID.
- [Import an offline contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-importoffline-1.md): Creates a new contract document for the provided contract ID based on imported third-party paper.
             
 On success, the contract status changes to "Author Contract".
- [Create an offline contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-createoffline-1.md): Creates a new contract record based on an imported third-party contract document and attaches the original document to the new contract.
 
 On success, the contract status changes to "Author Contract".
- [Create a contract from an executed contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-storeexecuted-1.md): Creates a new contract record from the provided executed contract document.
 
 On success, the contract status changes to "Activated".
- [Import a large document.](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-importoffline-large-1.md): Imports a large document for the specified contract ID. This operation allows the user to upload or reference 
 a document that is already uploaded to a filestore, and it links the document to the contract.
- [Store an executed large document.](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-storeexecuted-large-1.md): Stores an executed large document for the specified contract ID. This operation allows the user to upload or reference 
 a document that is already uploaded to a filestore, and it links the document to the contract.
- [Creates an offline contract and imports a large document linked to it.](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-createoffline-large-1.md): Creates a new contract record based on an imported third-party contract document and attaches the original document to the new contract.
 
 On success, the contract status changes to "Author Contract".
- [Upload a large contract document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-large-1.md): Uploads a large document to the specified contract ID.
 This API allows you to reference a document that is already uploaded to the filestore and link it to the contract. 
 Provide the file name, file path, and optional document attributes in the request payload.
- [Protect a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-documents-documentid-protect-1.md): Protects a document. This API takes a copy of the document with the provided document ID, applies the respective document protection based on the given action, and returns the copy.
 
 Document protection is applicable only for "DOCX" documents.
- [Activate a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-activate-1.md): Activates a contract or brings it into effect after it has been finalized and signed by stakeholders.
 Activating a contract ensures that key dates and events are monitored by the system and that all in-effect contracts are included in appropriate searches and views.
 To activate a contract, the contract status must be fully signed, and the contract's Contract Start Date and Contract End Date fields must have valid dates.
 
 Activation changes the contract's status changes to Activated. The Activated By field is updated to the current user and the  Activated Date field is updated to the current date.
 
 Additionally, this operation deletes any documents that were not selected at the time of activation.
- [Amend a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-amend-1.md): Amends a contract. During the term of a contract, there may be a need to modify its language or terms. This API creates a new version of the contract record after amendment. The new, amended record shares the same base contract number as the original, but with an incremented decimal, and all data from the original version is copied to the new version.
 
 To amend a contract, the contract's status must be Activated, Superseded, or Being Terminated.
 
 On amendment (success), the status of the original contract changes to "Being Amended".
- [Renew a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-renew-1.md): Renews a contract at the end of the term. The renewed contract (new contract) shares the same base contract number as the original contract with an incremented decimal. All data from the original is copied to the renewed contract.
 The new contract's start date is set to the original contract's end date.
 
 To be renewable, a contract's status must be Activated, Superseded, or Being Terminated.
 
 On renewal (success), the original contract's status changes to Being Renewed.
- [Clone a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-clone-1.md): Clones an existing contract, creating a new contract version. All data from the original version is copied to the new version. The status of the original contract does not change.
- [Terminate a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-terminate-1.md): Terminates an executed contract. To be terminated, a contract must have an Activated status. On contract termination, any related amended and renewed agreements are terminated along with the contract. Like the contract's status, those contracts' status is changed to Terminated.
- [Expire a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-expire-1.md): Expires a contract when the contract term ends. To mark a contract as expired, its status must be Activated, Superseded, or Being Terminated. On expiration, the contract's status is changed to Expired.
- [Cancel a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-cancel-1.md): Cancels a contract. To cancel a contract, the status category of the contract must be Request, In Authoring, In Signatures or In Filing. On cancellation, the contract status is changed to Canceled.
- [Submit Request](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-submitrequest-1.md): Submits a request to process the contract based on the steps defined in the agreement rule.
- [Update contract status by lifecycle action](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-update-contract-lifecycle-status-1.md): Updates the contract's status and status category based on the specified lifecycle action and record type.
- [Create an obligation for a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-1.md): Creates an obligation record for the specified Contract ID. Name is a required field to create an obligation.   
 You can specify values for the following additional fields for the obligation.
 * ObligationType 
 * Priority 
 * Description 
 * AccountableParty 
 * Assignee 
 * Reviewer 
 * DueDate 
 * Comments
- [Delete contract obligations](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-obligations-1.md): Deletes obligations associated with the specified contractID. If contractObligationIds are provided, only those specific obligations are deleted; otherwise, all obligations linked to the contract are deleted.
- [Get all contract obligations](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-query-1.md): Fetches all contract obligations associated with a specified contract ID.
 You can refine the results by applying filters and sorting options using query parameters.
- [Get a contract obligation by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-obligations-obligationid-1.md): Fetches a contract obligation by its ID.
- [Update a contract obligation](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-obligations-obligationid-1.md): Updates a contract obligation record.
- [Delete a contract obligation by ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-obligations-obligationid-1.md): Deletes a contract obligation by its ID.
- [Create a contract obligation document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-documents-1.md): Creates a new document for the specified contract obligation.
- [Get contract obligation document details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-obligations-obligationid-documents-documentid-1.md): Fetches document details for the provided document ID within a specific contract obligation.
- [Delete a contract obligation document](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-obligations-obligationid-documents-documentid-1.md): Deletes a document based on the provided document ID for the specified contract obligation.
- [Get the obligation and fulfillment details of the contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligation-fulfillments-1.md): Fetches the obligation and fulfillment details of the contract with document details
- [Get a contract obligation fulfillment by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-1.md): Fetches a contract obligation fulfillment by its ID.
- [Update a contract obligation fulfillment](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-1.md): Modifies an existing contract obligation fulfillment by updating the provided field values.
- [Get fulfillment history](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-history-query-1.md): Fetches fulfillment history for a contract obligation.
- [Perform an action on a contract obligation fulfillment](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-fulfillmentid-fulfillmentaction-1.md): Executes the specified action on a contract obligation fulfillment.
- [Create records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-objectname-1.md): Creates one or more records for the named object.
- [Delete an object's records](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-objectname-1.md): Deletes one or more records for a named object.
- [Update an object's details](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-objectname-objectid-1.md): Updates the details for a named object (by objectName and objectId), if such an object exists.
- [Get an object's details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-objectname-objectid-1.md): Retrieves details for a named object (by objectName and objectId).
- [Delete an object's details](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-objectname-objectid-1.md): Deletes the details for a named object (by objectName and objectId).
- [Filter an object's records](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-objectname-query-1.md): Retrieves all records for a named object and sorts the results per the query parameters.
- [Link contracts by relationship](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-relationships-1.md): Links one contract to another. Contracts can be linked using IsAmendmentFor, IsAmendedBy, IsRenewalFor, and IsRenewedBy relationships.
 When you amend or renew a contract, the original and the new contract are linked automatically.
- [Get contract relationship details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-relationships-1.md): Gets relationship details of the provided contract ID if a contract has linked contracts.
- [Link contracts using RelationshipFromType and RelationshipToType](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-relationships-link-1.md): Links one contract to another by creating the specified relationship. Provide the source contractId and a ContractRelationshipRequest containing the RelatedContractId, RelationshipFromType and RelationshipToType (for example: IsAmendmentFor, IsAmendedBy, IsRenewalFor, IsRenewedBy, IsNDAFor). Specify standard as well as custom picklist values configured for RelationshipFromType and RelationshipToType fields in RelatedAgreement object in the schema manager. The API returns the created RelatedAgreement with linked contract IDs and relationship details.
- [Unlink related contracts](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-relationships-relationshipid-1.md): Unlinks one contract from another.
- [Get hierarchy of a contract](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-hierarchy-1.md): Gets the contract hierarchy for the provided contract ID and fetches the contract's child and descendant contracts.
- [Query a contract relationship](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-relationships-query-1.md): Fetches the list of related contracts for the given contract ID.
- [Get the contract request details](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-id-1.md): Fetches the contract request details for the provided contract request ID
- [Update a contract request record](https://developer.conga.com/contracts/reference/put_api-clm-v1-requests-id-1.md): Updates a contract request record for the provided contract ID in CLM.
 
 The required fields to update a contract request record are: 
 * Name 
 * Account 
 * RecordType
- [Delete a contract request](https://developer.conga.com/contracts/reference/delete_api-clm-v1-requests-id-1.md): Deletes the contract request permanently from the system for the provided contract ID.
- [Create a contract request](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-1.md): Creates a contract request record in CLM. 
 
 The required fields to create a contract request record are: 
 * Name 
 * RecordType
- [Upload documents to a contract request](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-id-documents-1.md): Uploads documents to a contract request record.
- [Delete documents by contract request ID](https://developer.conga.com/contracts/reference/delete_api-clm-v1-requests-id-documents-1.md): Deletes one or more documents associated with a specific contract request. You can provide a list of document IDs to delete specific documents, or omit the list to delete all documents linked to the contract request. The API permanently removes the document data while retaining the metadata with the "IsDeleted" flag set to true. The API returns a confirmation of the deletion status.
- [Get a contract request's related documents metadata](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-id-documents-1.md): Fetches all the related documents for the provided contract ID.
- [Get contract request records](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-query-1.md): Executes the query request against the contract request records and returns the matching records.
- [Convert a contract request to an agreement](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-contractrequestid-convert-1.md): Converts a contract request into an agreement in CLM.
 Optionally processes DAI (Document AI) on copied documents when useDai is true and worksheetId is provided.
- [Get incoming contract requests](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-incoming-requests.md): Retrieves contract requests that are pending approval and assigned to the current user or their groups.
 Supports filtering, sorting, and pagination through the CustomQuery parameter.
- [Get a user's contract request authority](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-id-action-eligibility.md): Checks if the current user has the permissions and role to approve, reject, or convert for a given contract, based on the user role (for example, Approver, contract Manager), association with the contract request (e.g., creator, owner, submitter), and the contract request's current status.
- [Add contract request team members](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-contractrequestid-teammembers.md): Adds one or more team members to a contract request and assigns them a team role.
- [Update contract request team member details](https://developer.conga.com/contracts/reference/put_api-clm-v1-requests-contractrequestid-teammembers-teammemberid.md): Updates the details of a specific team member assigned to a contract request.
- [Get contract request team member details](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-contractrequestid-teammembers-teammemberid.md): Retrieves details of a specific team member assigned to a contract request, including their associated team role.
- [Remove a team member from a contract request](https://developer.conga.com/contracts/reference/delete_api-clm-v1-requests-contractrequestid-teammembers-teammemberid.md)
- [Get contract request team members by action](https://developer.conga.com/contracts/reference/get_api-clm-v1-requests-contractrequestid-teammembers-by-action-actionname.md): Retrieves a list of team members assigned to a contract request who are associated with a specific contract action.
- [Get all team members of a contract request](https://developer.conga.com/contracts/reference/post_api-clm-v1-requests-contractrequestid-teammembers-query.md)
- [Add contract team members](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-teammembers-1.md): Adds one or more team members to a contract and assigns them a team role.
- [Update contract team member details](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-teammembers-teammemberid-1.md): Updates the details of a specific team member assigned to a contract.
- [Get contract team member details](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-teammembers-teammemberid-1.md): Retrieves details of a specific team member assigned to a contract, including their associated team role.
- [Remove a team member from a contract](https://developer.conga.com/contracts/reference/delete_api-clm-v1-contracts-contractid-teammembers-teammemberid-1.md)
- [Get contract team members by action](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-teammembers-by-action-actionname-1.md): Retrieves a list of team members assigned to a contract who are associated with a specific contract action.
- [Get all team members of a contract](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-teammembers-query-1.md)
- [Generate a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-generate-1.md): Generates a new contract document using an existing template. Templates can be created using X-Author for Contracts.
 
 On generating a new document, the contract status changes to "Author Contract".
- [Regenerate a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-regenerate-1.md): Regenerates a contract document using an existing template. Templates can be created using X-Author for Contracts.
 
 The contract status does not change.
- [Generate a supporting document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-supportingdocument-1.md): Generates a new supporting document using an existing template. Templates can be created using X-Author for Contracts.
 
 The contract status does not change.
- [Join documents](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-joindocuments-1.md): Merges multiple documents into a single document based on the provided document IDs. All documents to be joined must be associated with the same contract.
- [Preview a document](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-previewdocument-1.md): Generate a preview contract document from an existing template. Templates can be created using X-Author for Contracts.
- [Create a document output format](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-output-formats-1.md): Creates a new record for a document's output format (doc, docx, pdf, or rtf), along with other options like adding a watermark.
- [Update document output format](https://developer.conga.com/contracts/reference/put_api-clm-v1-settings-documents-output-formats-1.md): Updates a document output format and its properties based on the document output format ID.
- [Get a document output format](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-output-formats-id-1.md): Gets document output format details based on the document output format ID.
- [Delete a document output format](https://developer.conga.com/contracts/reference/delete_api-clm-v1-settings-documents-output-formats-id-1.md): Deletes a document output format based on the provided ID.
- [Show document output format records](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-output-formats-query-1.md): Queries document output format records for matching details.
- [Add a document protection setting](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-protections-1.md): Adds a document protection setting for a user role and a contract type.
- [Update a document protection setting](https://developer.conga.com/contracts/reference/put_api-clm-v1-settings-documents-protections-1.md): Updates a list of fields in a document protection setting.
- [Copy document protection settings](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-protections-clone-1.md): Copies document protection settings that do not exist in destination roles from the source role.
- [Get a document protection setting](https://developer.conga.com/contracts/reference/get_api-clm-v1-settings-documents-protections-documentprotectionid-1.md): Fetches a document protection setting.
- [Delete a document protection setting](https://developer.conga.com/contracts/reference/delete_api-clm-v1-settings-documents-protections-documentprotectionid-1.md): Deletes a document protection setting.
- [Query document protection settings](https://developer.conga.com/contracts/reference/post_api-clm-v1-settings-documents-protections-query-1.md): Retrieves multiple document protection settings based on query parameters such as Limit, Skip, Sort, GroupBy, etc.
- [Export query results to Excel/CSV](https://developer.conga.com/contracts/reference/post_api-clm-v1-objects-export-filename-format-1.md): Executes a query against a single object type and exports the results to the specified format (Excel or CSV).
 The query supports filtering, sorting, and field selection.
- [Export search results to Excel/CSV](https://developer.conga.com/contracts/reference/post_api-clm-v1-objects-multiple-export-filename-format-1.md)
- [Get all active obligation fulfillments for the Manage Fulfillment listing](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-obligations-fulfillments-query.md): Fetches all active obligation fulfillment records excluding Canceled and Superseded status records at database level.
 
 For Recurring Obligations (Monthly, Quarterly, Custom):
 - Excludes terminal statuses: FulfilledOnTime, FulfilledLate, Waived
 - If there are overdue pending fulfillments (DueDate Less Than Today with PendingFulfillment or PendingReview status):
   Shows all overdue pending fulfillments PLUS the next upcoming fulfillment (earliest future DueDate)
 - If all pending fulfillments are future (DueDate Greater Than Or Equal Today):
   Shows only the next upcoming (earliest) pending fulfillment
 - Prevents showing all future fulfillments - only the immediate next one
 
 Results are sorted by due date and include contract and obligation details for each fulfillment.
- [Get activity history for all fulfillments of a contract obligation](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-activityhistory-query.md): Fetches the combined activity history across all fulfillments of a specific obligation.
 Each row includes FulfillmentName, FulfillmentNumber, Comments, Date, User, Action, Status, and AttachmentCount.
- [Get all fulfillments for a contract obligation](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-obligations-obligationid-fulfillments-query.md): Fetches fulfillment records for a specific obligation in a contract.
- [Update multiple object records](https://developer.conga.com/contracts/reference/put_api-clm-v1-contracts-contractid-objectname.md): Updates one or more records for a named object. Each record in the request body must include an 'Id' field.
- [Get in-effect view of contract detail changes](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-in-effect-view-details-1.md): Fetches contract detail changes that occurred during an amendment, enabling a comparison of the amendment's change history.
- [Get in-effect view of contract document changes](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-in-effect-view-documents-1.md): Fetches contract document changes that occurred during an amendment, enabling a comparison of the amendment's change history.
- [Get in-effect view of contract clause changes](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-in-effect-view-clauses-1.md): Fetches contract clause changes that occurred during an amendment, enabling a comparison of the amendment's change history.
- [Initiate a review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-1.md): Sends contract documents for review and initiates a review by sending contract documents to reviewers.
  
  Two types of reviews are available in CLM, "Simple Review" and "Microsoft 365 Review". 
  * When you send documents for Simple Review, all review documents and supporting documents are sent to reviewers as email attachments. Reviewers can email reviewed documents back to the review initiator.
  * When you send a document for Microsoft 365 Review, the review document is shared as Microsoft 365 document links and supporting documents are sent as email attachments. Reviewers can directly review documents via Microsoft 365 and  reviews are imported into CLM automatically at the end of the review. Documents sent for Microsoft 365 review must be in DOCX format, though supporting documents can be of any format. Microsoft 365 Review can be initiated only for one document at a time.
 After completing any ongoing review, you can initiate a new review for another document from the same contract. In both reviews, the contract status changes to "Other Party Review" after documents are sent for review.
- [Get contract review details in CLM](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-reviews-1.md): Retrieves details of any active review cycle for the specified contract. Provide the contractId to return the review cycle with metadata such as reviewId, status, reviewers, documents, timestamps and actionable flags.
- [End a review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-end-1.md): Ends a review and marks it as completed.
 * For Simple Review, the contract status changes to Ready for Signature. 
 * For Microsoft 365 Review, in addition to the status change to Ready for Signature, all reviewers' Microsoft 365 document access is revoked. 
 The final version of the reviewed document is available in the contract with a new version number. An email notification is sent to all active reviewers.
- [Cancel a review](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-cancel-1.md): Cancels a review and marks it as canceled.
 * This API is not applicable to Simple Review. 
 * For Microsoft 365 Review, the contract status changes to Author Contract. Microsoft 365 document access is revoked for all reviewers and an email notification is sent to all active reviewers.
- [Add reviewers to a review cycle in CLM](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-reviewers-1.md): Adds one or more reviewers to an active review for the specified contract. Provide the contractId, reviewId, externalReviewToken for Microsoft 365 review and ReviewersAddRequest containing reviewer details. The API returns the updated review details. This API is applicable to Microsoft 365 Review.
- [End review of reviewers](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-reviewers-end-1.md): Ends a review for one or more reviewers. You cannot end a review that was canceled or ended. 
 An email notification is sent to all reviewers when the review ends. Changes made to the review document before ending the review are retained. 
 This API is not applicable for Simple Review.
- [Remove reviewers](https://developer.conga.com/contracts/reference/post_api-clm-v1-contracts-contractid-reviews-reviewid-reviewers-cancel-1.md): Removes one or more reviewers from an active review. You cannot remove reviewers from a canceled or ended review. When you remove reviewers from an active review, Microsoft 365 document access is revoked for the removed reviewers. An email notification is sent to all removed reviewers. If any changes were made to the review document before removing the reviewer, those changes are retained. 
 This API is not applicable for Simple Review.
- [Search users for document review in CLM](https://developer.conga.com/contracts/reference/get_api-clm-v1-contracts-contractid-reviews-reviewtype-searchstring-1.md): Searches users by name or email ID, for adding as reviewers to inititiate review cycle for a contract. Provide the contractId, reviewType, and searchString. The API returns a list of users with their Id, Name, EmailID, RecipientType, and Role.
 * For Simple Review, the endpoint searches users and contact data sources.
 * For Microsoft 365 Review, the endpoint searches users, contact data sources, and Active Directory users.
- [Get Active Directory access token](https://developer.conga.com/contracts/reference/post_api-clm-v1-reviews-token-1.md): Gets an Active Directory access token for Microsoft 365 Review to test Microsoft 365 SharePoint configurations.
- [Create a team role](https://developer.conga.com/contracts/reference/post_api-clm-v1-teamroles-1.md): Creates a new team role in the CLM system to assign people to duties relating to contract negotiation, management, or enforcement.
 Team roles support mapping of both standard actions and custom actions (created by cloning standard actions) for Send for Review and Send for Signature contract actions. 
 Provide the team role name, description, and optional action mappings in the request payload.
- [Delete team roles](https://developer.conga.com/contracts/reference/delete_api-clm-v1-teamroles-1.md): Permanently deletes the records of the provided team role IDs from the system.
- [Update an existing team role](https://developer.conga.com/contracts/reference/put_api-clm-v1-teamroles-teamroleid-1.md): Updates an existing team role record.
- [Get a team role by ID](https://developer.conga.com/contracts/reference/get_api-clm-v1-teamroles-teamroleid-1.md): Returns a team role record by ID.
- [Delete a team role](https://developer.conga.com/contracts/reference/delete_api-clm-v1-teamroles-teamroleid-1.md): Permanently deletes the record of the provided team role ID from the system.
- [Query team role records](https://developer.conga.com/contracts/reference/post_api-clm-v1-teamroles-query-1.md): Returns team role records matching the query request.
- [Get user profile authorization](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-authorize-1.md): Gets a review service auth URL or auth token based on your administrator settings.
- [Get an auth token for Google service account flow](https://developer.conga.com/contracts/reference/post_api-review-v1-google-authorize-1.md): Receives encrypted JSON for the Google service account, decrypts it, generates an access token, and returns the token.
- [Get an auth token for delegated flow](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-delegated-token-1.md): Gets an auth token based on your administrator settings, review type, and auth code. This endpoint is only for delegated flow.
- [Get review details](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-reviewid-1.md): This API retrieves the review ID, which includes associated review status information and properties.
- [Cancel a review process](https://developer.conga.com/contracts/reference/delete_api-review-v1-reviewtype-reviewid-1.md): Cancels a review process you started. You must identify the review with the reviewID parameter and you can invoke an existing email template using emailTemplateId.
- [Get reviews](https://developer.conga.com/contracts/reference/get_api-review-v1-objecttype-objectid-reviews-1.md): This API retrieves reviews based on a Review's parent object ID.
- [Send a document for review](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-start-1.md): Sends a document for review to your selected approvers.
- [End my review](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-reviewid-end-1.md): Ends a review process you started. You must pass the reviewId of the process you will end. Passing EmailTemplateId enables you to designate an existing email template to send ending a review. The `file` parameter (required for Normal-type review flows) names the file to process for review.
- [Get reviewers](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-reviewid-reviewers-1.md): This API retrieves the status details of all the reviewers and assocated details corresponding to a review request.
- [Add reviewers](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-reviewid-reviewers-1.md): Adds reviewers to a review process that has already started. You must identify the review and pass an addreviewerrequest parameter. The API returns a list of reviewer IDs.
- [Cancel a reviewer](https://developer.conga.com/contracts/reference/delete_api-review-v1-reviewtype-reviewid-reviewers-reviewerid-1.md): Cancels the review process for an individual reviewer and revokes their permission to review the document. You must pass the IDs of the review and the reviewer and you can designate an email template for the message sent after you cancel the review.
- [End a reviewer's review](https://developer.conga.com/contracts/reference/post_api-review-v1-reviewtype-reviewid-reviewers-reviewerid-end-1.md): This API ends the review process for an individual user and revokes permission to review a document. You must pass the reviewID and reviewerID parameters to identify the review and the reviewer. You can designate an email template for the message sent after you revoke review permission.
- [Validate Sharepoint site](https://developer.conga.com/contracts/reference/get_api-review-v1-office365-sites-sitename-validate-1.md): Checks if the custom-created Sharepoint site is valid.
- [Search users](https://developer.conga.com/contracts/reference/get_api-review-v1-reviewtype-reviewers-query-1.md): Retreives user details matching your search string. You must pass a search string in the searchText parameter.
- [Gets existing users from search text](https://developer.conga.com/contracts/reference/get_api-review-v1-office365-active-directory-users-1.md)
- [Toggle connect to CRM flag](https://developer.conga.com/contracts/reference/put_api-xauthor-v1-config-management-crm-connection-1.md)
- [Get AI feature settings](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-feature-settings-ai-1.md): Retrieves AI feature setting details, specifically whether the Copilot, Clause Semantic, and Redline AI feature bits are enabled.
- [Get external connection status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-feature-settings-1.md): Returns the status of the isExternalDataConnectionEnabled Boolean, indicating the status of the external data connection.
- [Get all feature settings](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-feature-settings-all.md)
- [Gets the information of google drive support and service account configurations in clm](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-google-config-1.md)
- [Retrieves the page field definitions and configuration metadata for the specified layout.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-layouts-layoutname-1.md)
- [Process document to prepare data for reconciliation preview](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-reconcile-preview-data-1.md): This includes field validation, field reconciliation and clause reconciliation. Short ciruiting execution if validation have some invalid field
- [/api/xauthor/v1/reconcile/preview-data/sametagfields](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-reconcile-preview-data-sametagfields-1.md)
- [Get the list of playbooks based upon contract type, source and legal entity.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks.md)
- [Get the list of rules matched for the playbook based upon contract type, source and legal entity.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules.md)
- [Retrieves the list of matched available playbooks for the specified contract.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-match.md)
- [Executes the specified playbook with the provided input document and returns the execution details.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-execute.md)
- [Retrieves the playbook execution results including clause rule and document rule outcomes.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-executions-executionid-results.md)
- [s
            Retrieves the current execution status of a redline operation, including extraction and redlining progress.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-redlines-executions-executionid-status.md)
- [Executes a rule against a contract document using the document content.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-ruleid-content-run.md)
- [Executes a rule against a contract document using pre-extracted rule text.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-ruleid-run.md)
- [Retrieves the clause rule execution result for a specific execution.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-clause-rule-executionid-results.md)
- [Retrieves the document rule execution result for a specific execution.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-playbooks-playbookid-rules-document-rule-executionid-results.md)
- [Convert RecordType to ContractType](https://developer.conga.com/contracts/reference/put_api-xauthor-v1-data-correction-template-field-record-type-1.md): Updates existing records for a schema change, renaming the RecordType field ContractType.
 After the update, existing records have a new ContractType key with the existing RecordType field data.
- [Add application usage data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-analytics-1.md)
- [Applications exception logging.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-logs-1.md)
- [To Log the custom metrics for the XA user](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-logs-custommetrics-1.md)
- [Retrieves the entities.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-schema-metadata-1.md)
- [Get a template clause's metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-metadata-1.md)
- [Get mark clause metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-mark-metadata-contractid-1.md)
- [Export package](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-template-migration-export-1.md)
- [Import package](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-template-migration-import-1.md)
- [Export a template](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-templates-export-1.md): Exports the selected template into a .zip file containing metadata and related clauses.
- [Import a template](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-templates-import-1.md): Imports the selected template using the .zip file created during the export process.
- [Get fields](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-metadata-1.md)
- [/api/xauthor/v1/contracts/{contractId}/reviews](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-reviews-1.md)
- [Get administrator settings](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-admin-settings-1.md): Retrieves all application-related information, like the user profile and org details.
- [Get Google account configuration](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-admin-settings-google-service-config-1.md): Retrieves Google Drive service account and folder configuration information.
- [Get agreements](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-query-1.md): Gets one or more agreements based on the parameters provided in the request body.
- [Get agreements owned by current logged in user](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-query-me-1.md): Gets one or more agreements based on the parameters provided in the request body.
- [List recently viewed agreements](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-recently-viewed-1.md): Gets one or more recently viewed agreements.
- [Get agreement details by contract](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-1.md)
- [Get agreement record type](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-record-type-1.md)
- [Create an agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-1.md)
- [Filter agreements with advanced search criteria](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-advance-query.md): Gets one or more agreements based on the advanced search filters provided in the request body.
 Supports complex filter expressions, field selection, sorting, pagination via offset and limit.
- [This method is to process the check-in or publish of the document  based on the AI suggestion and the details provided in the request.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ai-redline-check-in-1.md)
- [This method to generate a preview of the updated contentbased on the AI suggestion and other details provided in the request](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ai-redline-preview-1.md)
- [/api/xauthor/v1/contracts/{contractId}/AI/redline/risks/{attachmentId}](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-ai-redline-risks-attachmentid-1.md)
- [/api/xauthor/v1/contracts/{contractId}/AI/redline/risks](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ai-redline-risks-1.md)
- [Get document content by attachment](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-1.md): Gets the document content by attachment ID. Responses are curated for Windows and Mac.
- [Get document content body](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-body-1.md): Gets the document content as string and as content bytes for the given attachment ID.
- [Get document or attachment by ID](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-1.md): Gets document/attachment for the given attachment ID.
- [Get file size in MB of the attachment by ID](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-size-1.md)
- [Get the docx octet stream](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-stream-1.md)
- [Get document in Word online](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-attachmentid-content-onedrive-stream-1.md)
- [Convert SDT elements to text](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-content-no-datepicker-1.md): This API checks the document for SDT (Structured Document Tag) elements like date pickers or drop-down lists from Microsoft Word's Developer tab,
 removes such content controls, and converts them to plain text elements. The API then opens the converted checked-out document in a new Word instance.
 OfficeJS does not support SDT elements except rich text format (RTF) fields (https://docs.microsoft.com/en-us/javascript/api/word/word.contentcontrolcollection?view=word-js-preview)
- [Get the name of a document file](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-suggested-filename-1.md)
- [/api/xauthor/v1/documents/{attachmentId}/content-body-metadata-extracted](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-body-metadata-extracted-1.md)
- [Get content metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-content-metadata-1.md)
- [Get agreement details](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-metadata-1.md)
- [Get document Clauses by attachment ID](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-clauses-1.md): Gets Clauses in a document/attachment for the given attachment ID.
- [Convert document content from OPC XML format to HTML](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-content-convert-opcxml-to-html.md)
- [Get metadata and custom properties](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-document-properties-1.md): Gets metadata with document's custom properties
- [Get document metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-metadata-1.md)
- [Get fields and clauses from document metadata](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-smart-elements-1.md)
- [Get V2 metadata JSON](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-attachmentid-metadata-v2-1.md)
- [Get V2 metadata JSON](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-gdocs-gdocfileid-metadata-1.md)
- [Remove document protection](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-unprotect.md): The unprotect an agreement document feature lets you to unprotect an agreement document without entering the password. This way, you can prevent sharing of passwords and unauthorized access to the document. This API disables protection of the document and applies full access to it based on the parameters passed in the request body. Fields passed in the request body include Agreement Name, and Protection Level.
- [Add document protection](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-documents-protect.md): The protect an agreement document feature lets you to protect the agreement document without entering the password. This way, you can prevent sharing of passwords and unauthorized access to the document. This API enables protection of the document based on the parameters passed in the request body. Fields passed in the request body include Agreement Name, and Protection Level.
- [Get the protection level of document.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-saveoption-protection-1.md)
- [Get the protection type of document.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-currentprotection-protections-1.md)
- [Check Send For Review status.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-reviews-details-1.md)
- [Check review cycle is pending or not.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-documents-reviews-status-1.md)
- [Sync the document.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-document-sync-1.md)
- [Update the document Properties](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-document-sync-update-document-properties-1.md)
- [Gets the attachment id by external id](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-document-sync-externalid-attachment-id-1.md)
- [Get accounts](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-accounts-name-1.md)
- [Get token information](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-authorization-token-info-1.md): Extracts the token after logging in, verifies the token on whether the user is verified on the Conga Platform or Salesforce platform, and returns this information.
- [Get contacts](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contacts-name-1.md)
- [Encrypt provided text](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-encryption-encrypt-1.md)
- [Retrieve dynamic lookup data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-query-objectname.md): This API query retrieves dynamic lookup data containing dynamic fields and dynamic entities. Provide the objectName in the parameters.
- [Retrieve record type](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-record-types-1.md): Retrieves the list of record types available in the document.
- [Reorder alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-clauseid-configurations-configurationid-alternates-re-order-1.md): Reorder clause configuration's alternate clauses
- [Link alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-clauseid-alternates-link-1.md): Links alternate clauses to a clause configuration. Alternate clause IDs are passed in the the alternate clause mapping's clause-ranking order.
 The clauseConfigurationId parameter is optional.
- [Unlink alternate clauses](https://developer.conga.com/contracts/reference/delete_api-xauthor-v1-clauses-clauseid-alternates-alternateclausemappingid-1.md): Unlinks alternate clauses from a clause configuration.
- [The Api is used to initiate the clause semantic comparison request](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-compare-1.md)
- [The API is used to get the comparison status on the basis of comparison id , it can give for multiple ids](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clause-compare-statuses-1.md)
- [The API is used to get the comparison status on the basis of comparison id](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clause-compare-comparisonid-status-1.md)
- [It returns the result after the semantic comparison is completed](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clause-compare-comparisonid-results-1.md)
- [Mark plain text as a clause](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-content-mark.md): Use this API to mark plain text as a clause. When you post to this endpoint, it applies the clause's clause boundary and smartness properties to the text.
- [Get clause content for document insertion](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-content-clauseid-1.md)
- [Get the markup clause details for both template and agreement in encoded format](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clause-content-markup-metadata-1.md)
- [List alternate clauses and sub-clauses](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-configurations-clauseconfigid-1.md)
- [Get alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-alternate-1.md): Gets alternate clauses for use in contract negotiations.
- [Get a clause bundle](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-bundles-name-1.md)
- [Validate alternate clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-alternates-check-1.md)
- [Get clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-query.md): The clause library contains clauses or clause templates that contain modular blocks of contractual language. These blocks can be reused across agreement templates. Using this API, you can fetch all available clauses in the clause library by passing the required filter criteria in the request body.
- [Filter clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-advance-query-1.md)
- [Promote a clause](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-clauses-promote.md): This API promotes a marked clause from an agreement to the clause library, entering that clause into the clause library's clause repository. Once the clause is available in the clause library, you can reuse it for the original agreement record even after regenerating the document or you can make the clause available for other agreements and users.
- [Get clause content as text or HTML](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-clauses-clauseid-versions-clauseversionid-richtext-content-1.md)
- [Create agreement clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-clauses-original-1.md): Creates one or more records of agreement clauses based on the agreementId provided in the parameters.
- [Create agreement clauses as final](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-clauses-final-1.md): Creates one or more records of agreement clauses as final based on the agreementId provided in the parameters.
- [Finalize a document's clause entries](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentid-clauses-final-1.md)
- [Create agreement clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentversionid-files-fileid-clauses-original-1.md): Creates one or more records of agreement clauses based on the agreementId provided in the parameters.
- [Create original entries for the agreement clauses](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentversionid-metadata-metadatafileid-clauses-original-1.md)
- [Retrieves the list of agreement clause entries which are revertible.](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-documents-documentversionid-clauses-revertible-1.md): Returns all agreement clauses that have latest action as modified and are revertible.
- [Check in a document specific to an agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-check-in-1.md)
- [Get agreement document versions](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-versions-1.md): Gets all the document versions associated with a specific agreement based on the agreement ID provided in the parameters.
- [Regenerate an agreement document with the selected template](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-regenerate-1.md)
- [Compare and merge documents](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-compareandmerge-1.md)
- [Get agreement tags](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-documents-documentid-tags-1.md)
- [Get lock status](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-lock-status-1.md): When an agreement is open, it is locked by the specific user for editing and cannot be checked out by anyone else. This API gets the current lock status of the agreement based on the agreement ID provided in the parameters.
- [Release an agreement lock](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-release-lock-1.md): Releases the agreement's lock based on the agreement ID provided in the parameters. After the lock is released, the user cannot edit the agreement or check it in.
- [Lock an agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-documentid-acquire-lock-1.md): Locks the agreement identified in the parameters. With the lock acquired, the user can edit the agreement document and check it in.
- [Import an offline agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-import-offline-1.md): Imports a contract document into an existing contract record. You must pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body include Agreement ID, Offline Mode, and Document Content.
- [Create an offline agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-documents-create-offline-1.md): Creates a new contract document and affixes it to a new contract record. Pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body include Record Type, Account Name, and Contact ID.
- [Create offline Agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-documents-create-offline-multipart-1.md): Creates a new contract document and affixes it into a new contract record. Pass the Agreement information in the request body to attach a document to an agreement. Fields passed in the request body include Record Type, Account Name, and Contact ID.
- [Import an offline agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-documents-import-offline-multipart-1.md): Imports a contract document into an existing contract record. You must pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body include Agreement ID, Offline Mode, and Document Content.
- [Create store executed agreement](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-documents-store-executed-multipart-1.md): Creates a new contract document and affixes it into a new contract record. Pass the agreement information in the request body to attach a document to an agreement. Fields passed in the request body include Record Type, Account Name, and Contact ID.
- [Get a template for an agreement](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-contracts-contractid-templates-1.md)
- [Performs post checkin activity like reconcilation / pdf file creation / metadata processing.
File content wont be read as part of this process.Request contains all the information related to file content which is required during checkin](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-check-in-1.md)
- [Get IDE job status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-discovery-ai-contracts-contractid-documents-attachmentid-status-1.md): - Null if IDE import request is not made
 - Complete or Job type is In-Review and status Pending
 - If job status is complete then we will retrive field and clause in next request and mean while we will display message to customer that we are processing document
   Else we will display other message to customer
- [Extract and mark the clauses and fields in the request document and also update the metadata](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-discovery-ai-contracts-contractid-documents-attachmentid-markup-document-1.md)
- [Get Locale Based Formatted Field Values](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-metadata-1-fields-retrieve-data-1.md)
- [Get field data with locale based formatted values](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-metadata-2-fields-retrieve-data-1.md)
- [Mark as field](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-mark-content-1.md): Creates a new field record. The specific content is highlighted and marked as a field. The required parameters are passed in the request body.
- [Mark as field](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-mark-content-2-1.md): Creates a new field record. The specific content is highlighted and marked as a field. The required parameters are passed in the request body.
- [Get field data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-data-retrieve.md): Retrieves all the field-related information based on field parameters that are passed in the request body.
- [Retrieves the reference to field name.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-references-metadata-1.md)
- [Get fields data validation.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-validate-1.md)
- [Get fields data validation for V2 metadata](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-validate-v2-1.md)
- [Get Locale Based Formatted Field Values](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-fields-data-fetch-1.md)
- [Validates the fields in a document for a given object and field API name.](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-objects-objectname-objectid-fields-fieldapi-validate-1.md)
- [Extract a document](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-documents-1.md): Submits a document for extraction process through CLM API.
- [Get document extraction status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-intelligent-imports-documents-status-contractid-attachmentid-1.md): Gets the status for requested document. Returns `true` if the document is already sent for extraction, else `false`.
- [Get IDE job status](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-intelligent-imports-jobs-status-contractid-attachmentid-1.md): - Null if IDE import request is not made
 - Complete or Job type is In-Review and status Pending
 - If job status is complete then we will retrive field and clause in next request and mean while we will display message to customer that we are processing document
   Else we will display other message to customer
- [Extract and mark the clauses and fields in the request document](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-documents-mark-clauses-and-fields-1.md)
- [Get the doc fields and clauses properties](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-documents-retrieve-properties-contractid-1.md)
- [Get Risk Insights Data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-risks-insights-query-1.md)
- [Update Risk Insights Score](https://developer.conga.com/contracts/reference/patch_api-xauthor-v1-intelligent-imports-risks-insights-1.md)
- [Add Risk Insights Score](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-risks-insights-1.md)
- [Get Risk Scale Data](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-intelligent-imports-risks-scales-1.md)
- [Delete Risk Insights](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-intelligent-imports-risks-insight-delete-1.md)
- [Get auth token](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-token-1.md)
- [Validate Sharepoint site](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-sites-sitename-validate-1.md): Checks if the custom-created Sharepoint site is valid.
- [Fetches the google authentication token for communicating with google APIs](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-google-token-1.md)
- [Get repeat and section data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ufc-repeat-data-1.md): Gets a table of repeat and section data to display in the UFC screen.
- [Update repeat and section data](https://developer.conga.com/contracts/reference/post_api-xauthor-v1-contracts-contractid-ufc-update-document-1.md): Update repeat and section data to display in UFC screen.
- [/api/xajs/v1/xAuthor/User/UsersByType](https://developer.conga.com/contracts/reference/post_api-xajs-v1-xauthor-user-usersbytype-1.md)
- [get logged in user info](https://developer.conga.com/contracts/reference/get_api-xauthor-v1-current-user-info-1.md)