Conga

Conga System Properties API

The System Properties API from Conga — 5 operation(s) for system properties.

GitHub OpenAPI

Operations 10

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /v1/system-properties Get approvals system properties · Get system properties #
Ask an LLM
“What are my current Approvals system properties, like max ad hoc groups?”
“Is email approval or the approval center turned on for my org?”
Tell an agent
Show the Approvals system properties.
Get the current system-wide approval settings.
POST /v1/system-properties Update approvals system properties · Update system properties #
Ask an LLM
“How do I change the maximum number of ad hoc approvers per group?”
“Can I enable user groups or email approvals system-wide?”
Tell an agent
Set the max ad hoc approvers per group to {MaxAdhocApproverPerGroup}.
Turn email approvals {IsEmailEnabled} and set the dashboard default tab to {DashboardDefaultTab}.
POST /v1/system-properties/email-config Create approvals email configuration · Create email configuration #
Ask an LLM
“Can I set up the approvals email configuration for the first time?”
“How do I add a compliance BCC address when creating email settings?”
Tell an agent
Create email configuration with reply-to address {ReplyToEmailAddress}.
Set up new email config with compliance BCC {ComplianceBCCEmailAddress}.
GET /v1/system-properties/email-config Get approvals email configuration · Get email configuration #
Ask an LLM
“What reply-to and compliance BCC addresses are configured for approval emails?”
“Is an organization-wide email address in use for approval notifications?”
Tell an agent
Show the approvals email configuration.
Get the current reply-to and CC email settings.
PATCH /v1/system-properties/email-config Change existing email configuration · Update email configuration #
Ask an LLM
“Can I change just the reply-to address on existing email settings?”
“Is inbound email processing something I can toggle later?”
Tell an agent
Change the existing reply-to address to {ReplyToEmailAddress}.
Update email config so inbound processing is {ShouldProcessInbound}.
GET /v1/system-properties/product-settings Get custom configurations by name · Get custom configurations #
Ask an LLM
“Can I fetch several named product setting configurations at once?”
“Which custom configurations exist for the settings I name?”
Tell an agent
Get product settings named {productSettingNames}.
Fetch the custom configs {productSettingNames}.
POST /v1/system-properties/product-settings Set a business object's custom configuration · Create or update a custom configuration #
Ask an LLM
“How do I set the approval status field for a business object?”
“Can I turn on rejection emails for one object's approvals?”
Tell an agent
Set the approval status field for {BusinessObject} to {ApprovalStatusField}.
Enable rejection emails {EnableRejectionEmails} on {BusinessObject}.
GET /v1/system-properties/product-settings/businessobjects Get product settings for all objects · Get all business object product settings #
Ask an LLM
“What Approvals product settings are configured across every business object?”
“Can I see all objects' product settings together?”
Tell an agent
Show Approvals product settings for all business objects.
List every object's product setting configuration.
DELETE /v1/system-properties/product-settings/{businessObject} Delete a business object's custom configuration · Delete a custom configuration #
Ask an LLM
“Can I remove the custom configuration for one object?”
“What happens when I delete an object's product setting config?”
Tell an agent destructive · confirm first
Delete the custom configuration for {businessObject}.
Remove product settings on the {businessObject} object.
GET /v1/system-properties/product-settings/{businessObject} Get one business object's custom configuration · Get a custom configuration #
Ask an LLM
“What custom configuration is set for a specific business object?”
“Is the rule engine callback enabled for this object?”
Tell an agent
Show the custom configuration for {businessObject}.
Get product settings for the {businessObject} object.

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/authentication/conga-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/rate-limits/conga-rate-limits.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/openapi/conga-system-properties-api-openapi.yml

Other Resources

🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/data-model/conga-data-model.yml
🔗
OAuthScopes
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/scopes/conga-scopes.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conventions/conga-conventions.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/errors/conga-problem-types.yml
🔗
Lifecycle
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/lifecycle/conga-lifecycle.yml
🔗
Conformance
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/conformance/conga-conformance.yml
🔗
Sandbox
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/sandbox/conga-sandbox.yml
🔗
Webhooks
https://raw.githubusercontent.com/api-evangelist/conga/refs/heads/main/asyncapi/conga-webhooks.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/conga:conga-system-properties-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

conga-system-properties-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Approvals System Properties API
  description: The Approvals API is used to submit, preview, and retrieve approval processes.
  version: v1
servers:
- url: https://rls.congacloud.com/api/approvals
security: []
tags:
- name: System Properties
paths:
  /v1/system-properties:
    get:
      tags:
      - System Properties
      summary: Get system properties
      description: Retrieves the system properties.
      operationId: SystemProperties_GetSystemProperties
      responses:
        '200':
          description: Product Settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductSettingSystemProperties'
      security:
      - oauth2: []
      - Bearer: []
    post:
      tags:
      - System Properties
      summary: Update system properties
      description: Updates the system properties with a system configuration request.
      operationId: SystemProperties_UpsertSystemConfig
      requestBody:
        x-name: upsertSystemConfigRequest
        description: The UpsertSystemConfigRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertSystemConfigRequest'
        required: true
        x-position: 1
      responses:
        '200':
          description: Updated system properties
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductSettingSystemProperties'
      security:
      - oauth2: []
      - Bearer: []
  /v1/system-properties/email-config:
    post:
      tags:
      - System Properties
      summary: Create email configuration
      description: Creates email configuration.
      operationId: SystemProperties_CreateEmailConfig
      requestBody:
        x-name: applicationEmailConfig
        description: The applicationEmailConfig
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationEmailConfig'
        required: true
        x-position: 1
      responses:
        '200':
          description: The created applicationEmailConfig.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationEmailConfig'
      security:
      - oauth2: []
      - Bearer: []
    get:
      tags:
      - System Properties
      summary: Get email configuration
      description: Retrieves the email configuration from system properties.
      operationId: SystemProperties_GetEmailConfig
      responses:
        '200':
          description: The email configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationEmailConfig'
      security:
      - oauth2: []
      - Bearer: []
    patch:
      tags:
      - System Properties
      summary: Update email configuration
      description: Updates email configuration.
      operationId: SystemProperties_UpdateEmailConfig
      requestBody:
        x-name: applicationEmailConfig
        description: The applicationEmailConfig
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApplicationEmailConfig'
        required: true
        x-position: 1
      responses:
        '200':
          description: The updated applicationEmailConfig.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApplicationEmailConfig'
      security:
      - oauth2: []
      - Bearer: []
  /v1/system-properties/product-settings:
    get:
      tags:
      - System Properties
      summary: Get custom configurations
      description: Retrieves custom configurations for multiple business objects.
      operationId: SystemProperties_GetMultipleProductSettings
      parameters:
      - name: productSettingNames
        in: query
        style: form
        explode: true
        required: true
        schema:
          type:
          - array
          - 'null'
          items:
            type: string
        x-position: 1
      responses:
        '200':
          description: The custom configuration (ProductSettingCustomConfig) for multiple business objects
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
      security:
      - oauth2: []
      - Bearer: []
    post:
      tags:
      - System Properties
      summary: Create or update a custom configuration
      description: Creates or updates the custom configuration (ProductSettingCustomConfig) for a business object.
      operationId: SystemProperties_UpsertCustomConfig
      requestBody:
        x-name: upsertProductSettingsRequest
        description: The UpsertProductSettingsRequest
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpsertProductSettingsRequest'
        required: true
        x-position: 1
      responses:
        '200':
          description: The custom configuration (ProductSettingCustomConfig) for a business object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductSettingCustomConfig'
      security:
      - oauth2: []
      - Bearer: []
  /v1/system-properties/product-settings/businessobjects:
    get:
      tags:
      - System Properties
      summary: Get all business object product settings
      description: Retrieves Approvals product settings for all business objects.
      operationId: SystemProperties_GetAllProductSettings
      responses:
        '200':
          description: Approvals product settings for all business objects
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  type: string
      security:
      - oauth2: []
      - Bearer: []
  /v1/system-properties/product-settings/{businessObject}:
    delete:
      tags:
      - System Properties
      summary: Delete a custom configuration
      description: Deletes the custom configuration (ProductSettingCustomConfig) for a business object.
      operationId: SystemProperties_DeleteCustomConfig
      parameters:
      - name: businessObject
        in: path
        required: true
        description: The business object name of the requested custom configuraiton
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: 'Boolean: Deleted Records Status.'
          content:
            application/json:
              schema:
                type: boolean
      security:
      - oauth2: []
      - Bearer: []
    get:
      tags:
      - System Properties
      summary: Get a custom configuration
      description: Retrieves the custom configuration (ProductSettingCustomConfig) for a business object.
      operationId: SystemProperties_GetCustomConfig
      parameters:
      - name: businessObject
        in: path
        required: true
        description: The business object name of the requested custom configuraiton
        schema:
          type: string
        x-position: 1
      responses:
        '200':
          description: Returns the custom configuration (ProductSettingCustomConfig) for a business object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProductSettingCustomConfig'
      security:
      - oauth2: []
      - Bearer: []
components:
  schemas:
    EmailAddress:
      type: object
      additionalProperties: false
      properties:
        Address:
          type:
          - string
          - 'null'
        DisplayName:
          type:
          - string
          - 'null'
    ChatNotificationType:
      type: string
      description: Specifies the types of notification that can be sent.
      x-enumNames:
      - None
      - Teams
      enum:
      - None
      - Teams
    UpsertSystemConfigRequest:
      allOf:
      - $ref: '#/components/schemas/ProductSettingSystemProperties'
      - type: object
        description: UpsertSystemConfigRequest
        additionalProperties: false
    OrganizationWideEmail:
      type: object
      additionalProperties: false
      properties:
        EmailAddress:
          $ref: '#/components/schemas/EmailAddress'
        Description:
          type: string
    UpsertProductSettingsRequest:
      allOf:
      - $ref: '#/components/schemas/ProductSettingCustomConfig'
      - type: object
        description: UpsertProductSettingsRequest
        additionalProperties: false
    ProductSettingSystemProperties:
      type: object
      description: ProductSettingSystemProperties
      additionalProperties: false
      properties:
        MaxAdhocGroup:
          type: integer
          description: MaxAdhocGroup
          format: int32
          default: 7
          example: 7
        MaxAdhocApproverPerGroup:
          type: integer
          description: MaxAdhocApproverPerGroup
          format: int32
          default: 7
          example: '7'
        DashboardDefaultTab:
          type:
          - string
          - 'null'
          description: DashboardDefaultTab
        BackupAssignmentEmailTemplate:
          description: The backup assignment email template to use
          oneOf:
          - $ref: '#/components/schemas/LookupObject'
        DelegateAssignmentEmailTemplate:
          description: The default assignment email template to use
          oneOf:
          - $ref: '#/components/schemas/LookupObject'
        CancellationEmailToApprovedOrNotified:
          type: boolean
          description: CancellationEmailToApprovedOrNotified
          default: false
        DeferredEmailProcessing:
          type: boolean
          description: DeferredEmailProcessing
          default: true
        SuppressQueueEmails:
          type: boolean
          description: SuppressQueueEmails
          default: true
        EnableUserGroups:
          type: boolean
          description: EnableUserGroups
          default: false
        IsEmailEnabled:
          type: boolean
          description: Enable email
          default: true
        EmailApprovalsStrictMode:
          type: boolean
          description: Email strict mode
          default: false
        DashboardRejectionComments:
          type: boolean
          description: DashboardRejectionComments
          default: false
        CreEnabled:
          type: boolean
          description: CreEnabled
          default: false
        AddApproverEnabled:
          type: boolean
          description: AddApproverEnabled
          default: true
        ApproverStepperStyle:
          type:
          - string
          - 'null'
          description: Approver Stepper Style
          default: Default
        ApprovalCenter:
          type:
          - string
          - 'null'
          description: System Property to store object names to be shown in the approval center
          example: '[{"ObjectName":"Agreement","DisplayName":"Contract"},{"ObjectName":"ProductConfiguration","DisplayName":"Product Configuration"}]'
        EnableAttachmentsOnApprovalCenter:
          type: boolean
          description: Enable Attachments On Approval Center
          default: false
        HideNavigationBar:
          type: boolean
          description: Hide Navigation bar in MyApproval Page redirected from Approval Center
          default: false
        ChatNotificationType:
          description: Gets or sets the types of chat notifications.
          example: Teams
          oneOf:
          - $ref: '#/components/schemas/ChatNotificationType'
    LookupObject:
      type: object
      additionalProperties: false
      properties:
        Id:
          type:
          - string
          - 'null'
        Name:
          type:
          - string
          - 'null'
    ProductSettingCustomConfig:
      type: object
      description: Settings
      additionalProperties: false
      properties:
        BusinessObject:
          type:
          - string
          - 'null'
          description: The business object
        EnableRuleEngineCallback:
          type: boolean
          description: Enables the rule engine callback
          default: false
        RuleBasedSubmitActionCallback:
          type: boolean
          description: Enables rule based submit callbacks
          default: true
        RecordLevelPermissionNameForPreview:
          type:
          - string
          - 'null'
          description: Record level permission name for previewing approval requests
        RecordLevelPermissionNameForSubmit:
          type:
          - string
          - 'null'
          description: Record level permission name for submitting approval requests
        RecordLevelPermissionNameForRecall:
          type:
          - string
          - 'null'
          description: Record level permission name for recalling approval requests
        ObjectsForCustomUser:
          type:
          - string
          - 'null'
          description: List of ObjectNames to be used while configuring CustomAssignee
        ApprovalStatusField:
          type:
          - string
          - 'null'
          description: Specifies the name of the ApprovalStatus field for custom context objects. Defaults to "ApprovalStatus" if not provided.
          default: ApprovalStatus
        HideDefaultDisplayFields:
          type: boolean
          description: Hide DefaultDisplayFields such as Sequence, SubSequence and Delegate Approver in priveiw/my approval page
          default: false
        EnableRejectionEmails:
          type: boolean
          description: EnableRejectionEmails
          default: false
        DetailsViewColumnCount:
          type: integer
          description: Number of columns in Approval Detail Layout
          format: int32
    ApplicationEmailConfig:
      type: object
      additionalProperties: false
      properties:
        EnableOrganizationWideEmailAddress:
          type:
          - boolean
          - 'null'
        OrganizationWideEmailConfig:
          $ref: '#/components/schemas/OrganizationWideEmail'
        OrganizationWideEmailAddresses:
          type: array
          items:
            $ref: '#/components/schemas/OrganizationWideEmail'
        EnableComplianceBCCEmail:
          type:
          - boolean
          - 'null'
        ComplianceBCCEmailAddress:
          oneOf:
          - $ref: '#/components/schemas/EmailAddress'
        ReplyToEmailAddress:
          oneOf:
          - $ref: '#/components/schemas/EmailAddress'
        CcEmailAddresses:
          type: array
          items:
            $ref: '#/components/schemas/EmailAddress'
        ShouldProcessInbound:
          type: boolean
  securitySchemes:
    Bearer:
      type: apiKey
      description: 'Use a JWT Bearer token. (Example: Bearer eyJhbGciO...)'
      name: Authorization
      in: header
    oauth2:
      type: oauth2
      description: Login with a Salesforce or SalesforceSandbox account
      flows:
        authorizationCode:
          authorizationUrl: https://login-rls.congacloud.com/api/v1/auth//connect/authorize
          tokenUrl: https://login-rls.congacloud.com/api/v1/auth//connect/token
          scopes:
            openid: openid
            profile: profile
            offline_access: offline_access
            Auth.Api.Platform: Auth.Api.Platform