JUMP TOOverviewAbout Conga Revenue Lifecycle PlatformREST API IntroductionUser ManagementUser AdminCreate a userpostGet all usersgetCreate multiple userspostUpdate multiple userspatchUpdate a userpatchDeactivate a userdeleteGet user details by user IDgetUpload userspostClone a userpostRestore a deactivated userputGet CSV format for user uploadgetGet a user's rolegetCheck if a user is assigned a rolegetUpdate a user's roleputAssign permission group to a userputDelete permission groups from a userdeleteRe-send welcome email to new userpostGet Integration user's clientIDgetGenerate Integration user secretpatchUser GroupCreate a user grouppostGet filtered user groupsgetUpdate a user groupputDelete a user groupdeleteGet user group details by user group IDgetUser Group MemberCreate a user group memberpostDelete a user group memberdeleteGet all user group membersgetGet user group member details by user group member IDgetRole AdminCreate a new rolepostGet all rolesgetCreate multiple rolespostUpdate a roleputDelete a roledeleteGet role information by IDgetCheck whether the role existsgetAssign permission groups to a roleputDelete permission groups from a roledeleteClone a rolepostAssign admin permissions to a roleputDelete admin permissions from a roledeleteAdmin PermissionsGet the master list of admin permissionsgetPermission GroupsGet the master list of permission groupsgetAdd permission group names to the master listpostDelete permission groupsdeleteClone the permission grouppostOrganizationUpdate organizational informationpatchGet an organization's informationgetGet the localegetGet the time zonegetGet the currency typegetOrganization External IntegrationAdd external identifierspostRemove external identifiersdeleteGet external identifiersgetUpdate external identifiersputGet all identity providers (IDPs)getAdd external identifierspostUpdate external identifiersputRemove external identifiersdeleteGet external identifiersgetUpdate external identifierspatchAPI ConnectionsAdd API connectionpostUpdate API connectionputGet API connectionsgetGet all API connectionsgetUpdate API connection statusputGuest UserCreate a guest userpostUpdate a guest userputDeactivate a guest userdeleteRestore a deactivated guest userputObject PermissionCreate a new object permissionpostGet all object permissionsgetCreate multiple object permissionspostDelete multiple object permission recordsdeleteGet object permission details by IDgetUpdate an object permissionputDelete an object permissiondeleteValidate object action permissiongetGet object permission details by object namegetRecord Type PermissionSet a record type's permissionpostUpdate a record type's permission for a given permission group and objectputSet multiple record type permissionspostGet the record type permission details by object and permission group namegetDelete a record type's permission by permission group and objectdeleteGet the record type permission details by IDgetUpdate a record type's permissionputDelete a record type's permission by IDdeleteAction PermissionsGet all action permissionsgetUserGet logged-in user informationgetGet logged-in user's localegetGet logged-in user's time zonegetGet logged-in user's currencygetGet logged-in user's currency formatgetGet all action permissionsgetGet record type permission details by ObjectNamegetTimezone and LocaleGet all time zonesgetGet all localesgetGet all decimal symbols from localesgetGet all digit grouping symbols from localesgetGet all long date formats from localesgetGet all short date formats from localesgetGet all time formats from localesgetGet all digit groups from localesgetGet all negative number formats from localesgetCurrency FormatGet all currency formatsgetSchema ManagerObject DefinitionDefine a new object schemapostList all object namesgetUpdate a schema definitionputGet a schema definitiongetSet an object's shared statusputDeprecate an objectpatchImport custom schemapostField DefinitionCreate a field definition for an objectpostDelete a custom field definitiondeleteUpdate an object's field definitionputSet the field to deprecatepatchValidate formula field expressionpostGet the list of formula functionsgetIndex DefinitionIndex a fieldpostDelete an existing indexdeletePicklist DefinitionCreate a new picklistpostUpdate a picklistputCreate a new picklist entrypostUpdate a picklist entry by valueputCreate picklist entries by valuepostUpdate picklist entries by valueputDependent Picklist DefinitionGet the dependent picklistgetCreate a new dependent picklist mappingpostUpdate the dependent picklistputDelete the dependent picklistdeleteRecordType DefinitionCreate a record type picklist entrypostUpdate record type picklist entriesputComplex Field DefinitionCreate new complex field metadatapostCreate a new complex fieldpostUpdate an object's complex field definitionputCreate complex fieldspostObject Definition TranslationDefine the translationpostUpdate translationputGet translationgetDelete translationsdeleteObject MetadataGet a schema definitiongetExport custom schemapostGet all dependenciesgetGet all referencesgetGet field metadatagetGet field dependenciesgetDataCustom ObjectInsert a new custom object recordpostGet all custom object recordsgetGet a custom object recordgetUpdate a custom object recordputDelete a custom object recorddeleteInsert custom object recordspostUpdate custom object recordsputDelete custom object recordsdeleteUpsert custom object recordspatchUpdate custom object records as per the criteriaputDelete custom object records as per the criteriadeleteExecute multiple queriespostExecute single querypostGet all record types for the custom objectgetCurrencyGet all currencygetAccountInsert a new account recordpostGet all account recordsgetGet a account record using account record IDgetUpdate a account recordputDelete a account recorddeleteInsert multiple account recordspostUpdate multiple account recordsputDelete multiple account recordsdeleteUpsert multiple account recordspatchExecute single querypostGet all account record typesgetContactInsert a new contact recordpostGet all contact recordsgetGet a contact record using contact record IDgetUpdate a contact recordputDelete a contact recorddeleteInsert multiple contact recordspostUpdate multiple contact recordsputDelete multiple contact recordsdeleteUpsert multiple contact recordspatchExecute single querypostGet all contact record typesgetOpportunityInsert a new opportunity recordpostGet all opportunity recordsgetGet a opportunity record using opportunity record IDgetUpdate a opportunity recordputDelete a opportunity recorddeleteInsert multiple opportunity recordspostUpdate multiple opportunity recordsputDelete multiple opportunity recordsdeleteUpsert multiple opportunity recordspatchExecute single querypostGet all opportunity record typesgetDocument ManagementDocumentsUpload documentspostDelete documents by their IDsdeleteUpload a single documentpostInitiate a multipart uploadpostUpload a single part of a large fileputComplete multipart uploadpostAbort a multipart uploaddeleteUpdate a documentputDelete a document by its IDdeleteGet document information by its IDgetUpdate the document metadata information for all versionsputGet a document's metadata by its IDgetGet a document by its IDgetGet documents by their IDsgetDelete documents by object type and IDdeleteGet documents by object type and IDgetGet version details by object type and IDgetClone a documentpostCheck a documentgetRetrieve document versionsgetGet a document by its ID and versiongetDelete a versioned documentdeleteSearch documentspostGet documents by object ID and file typegetConfiguration ManagementConfigurationAdd a configurationpostUpdate a configurationputDelete a configurationdeleteGet a configurationgetGet multiple configurationspostGet configurations by categorygetExport custom configurationpostImport custom configurationpostGet configuration categoriesgetLocalizationTranslation AdminGet a localized valuegetDelete the translation valuedeleteGet locales where translations are definedgetSearch for translationpostGet translations by Locale and ModulegetDelete translation valuesdeleteExport CSV with default locale (en-US)postImport translation CSVpostAdd translation valuepostInsert multiple translationspostUpdate the translation valueputRetrieve all modulesgetAdd translation modulepostDelete translation moduledeleteTranslation RuntimeGet translated value for the user's localegetGet translated values for the user's localepostGet translated values with parameters for the user's localepostGet translated value and user localegetEmailEmail TemplateRender an email templatepostRender an unsaved email templatepostCreate an email templatepostGet the list of email templatesgetCreate a template attachment for a given template IDpostGet an email template by IDgetUpdate an email templateputDelete an email templatedeleteDelete a template attachment for a given template IDdeleteDelete all template attachments for a given template id at oncedeleteGet the list of email templatesgetClone the email templatepostEmail Template CategoryCreate an email template categorypostGet the list of email template categoriesgetGet an email template category by IDgetUpdate an email template categoryputDelete the email template categorydeleteEmail SenderSend an emailpostSend bulk/mass emailpostExtensibilityCustom CodeRetrieve custom code by project namegetDelete a custom code by namedeleteEnable debug logpostGet all custom codesgetExecute the custom codepostDownload the projectgetAdd a trusted API configurationpostGet all trusted API configurationsgetUpdate a trusted API configurationputDelete a trusted API configurationdeleteRetrieve a trusted API configuration by namegetRetrieve a trusted API configuration by URIgetRetrieve all allowed HTTP verbsgetAdd a trusted object configurationpostList all trusted object configurationsgetUpdate a trusted object configurationputDelete a trusted object configurationdeleteGet a trusted object configuration by namegetList allowed operationsgetCallbackUpdate callback contract mappingputGet all callback contractsgetGet callback contract detailsgetGet callback custom code setting configurationgetUpsert callback custom code setting configurationputGet all modulesgetGet all callback contracts by module namegetConga HooksRetrieve a data change rule by namegetUpdate a data change ruleputDelete a data change ruledeleteInsert a new data change rulepostRetrieve all data change rulesgetRetrieve all supported event types in service hook rulesgetAPI ResourceResolve a URIpostCreate a new API resourcepostGet all API resourcesgetGet API resource information by resource namegetDelete an API resourcedeleteClone an API resourcepostCreate an API resource URIpostGet URIs by name or verbgetUpdate URI entry informationputDelete a URIdeleteSearchSearch AdminGet the search settinggetUpdate object search settingputDelete object search settingdeleteGet all search settingsgetCreate a search settingpostIndex a documentpostGet the data sync status of an objectgetGet the data sync status of all objectsgetReindex specific objectpostResync data for objectspostResync data for an objectpostSearch RuntimeSearch an objectpostSearch documentspostSearch objectspostRetrieve fields from the search settings or databasegetSchedulerSchedulerList scheduled jobsgetGet scheduled job detailsgetDelete a scheduled jobdeleteCreate a new cron scheduled jobpostCreate a one-time scheduled jobpostExecute the scheduled jobpostUpdate the scheduled jobputDisable the scheduled jobputEnable scheduled jobputGet scheduled job execution historygetExport a scheduled jobgetExport all scheduled jobspostCreate or update scheduled jobs by organizationpostConversion ManagementCurrency AdminRetrieve a currency rate by IDgetUpdate a currency rateputDelete currency rate by IDdeleteAdd a new currency ratepostGet all currency ratesgetAdd multiple currency ratespostUpdate multiple currency ratesputCurrency RuntimeRetrieve effective currency ratepostRetrieve effective currency ratespostRetrieve converted currencypostFrequency Conversion AdminRetrieve a frequency conversion rate by IDgetUpdate a frequency conversion rateputDelete frequency conversion rate by IDdeleteGet all frequency conversion ratesgetAdd a new frequency conversion ratepostAdd multiple Frequency conversion ratespostUpdate multiple frequency conversion ratesputFrequency Conversion RuntimeRetrieve effective frequency Conversion ratepostUOM Conversion AdminRetrieve a UOM conversion rate by IDgetUpdate a UOM conversion rateputDelete UOM conversion rate by IDdeleteGet all UOM conversion ratesgetAdd a new UOM conversion ratepostAdd multiple UOM conversion ratespostUpdate multiple UOM conversion ratesputUOM Conversion RuntimeRetrieve effective UOM conversion ratepostGet external identifiersget https://rls.congacloud.com/api/user-management/v1/integrationsReturns the external identifiers of an external integration.