Conga · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Approvals System Properties API
11 actions
11 updates
phrasing
extends
openapi/conga-system-properties-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
What the actions change
x-apievangelist-phrasing
Targets 11
$.info
$.paths['/v1/system-properties'].get
$.paths['/v1/system-properties'].post
$.paths['/v1/system-properties/email-config'].get
$.paths['/v1/system-properties/email-config'].post
$.paths['/v1/system-properties/email-config'].patch
$.paths['/v1/system-properties/product-settings'].get
$.paths['/v1/system-properties/product-settings'].post
$.paths['/v1/system-properties/product-settings/businessobjects'].get
$.paths['/v1/system-properties/product-settings/{businessObject}'].get
$.paths['/v1/system-properties/product-settings/{businessObject}'].delete
OpenAPI Overlay
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Approvals System Properties API
version: 1.0.0
extends: openapi/conga-system-properties-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 10
- target: $.paths['/v1/system-properties'].get
update:
x-apievangelist-phrasing:
intent: Get approvals system properties
effect: read
questions:
- What are my current Approvals system properties, like max ad hoc groups?
- Is email approval or the approval center turned on for my org?
instructions:
- text: Show the Approvals system properties.
- text: Get the current system-wide approval settings.
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties'].post
update:
x-apievangelist-phrasing:
intent: Update approvals system properties
effect: write
questions:
- How do I change the maximum number of ad hoc approvers per group?
- Can I enable user groups or email approvals system-wide?
instructions:
- text: Set the max ad hoc approvers per group to {MaxAdhocApproverPerGroup}.
slots:
MaxAdhocApproverPerGroup: requestBody.MaxAdhocApproverPerGroup
- text: Turn email approvals {IsEmailEnabled} and set the dashboard default tab to {DashboardDefaultTab}.
slots:
IsEmailEnabled: requestBody.IsEmailEnabled
DashboardDefaultTab: requestBody.DashboardDefaultTab
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/email-config'].get
update:
x-apievangelist-phrasing:
intent: Get approvals email configuration
effect: read
questions:
- What reply-to and compliance BCC addresses are configured for approval emails?
- Is an organization-wide email address in use for approval notifications?
instructions:
- text: Show the approvals email configuration.
- text: Get the current reply-to and CC email settings.
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/email-config'].post
update:
x-apievangelist-phrasing:
intent: Create approvals email configuration
effect: write
questions:
- Can I set up the approvals email configuration for the first time?
- How do I add a compliance BCC address when creating email settings?
instructions:
- text: Create email configuration with reply-to address {ReplyToEmailAddress}.
slots:
ReplyToEmailAddress: requestBody.ReplyToEmailAddress
- text: Set up new email config with compliance BCC {ComplianceBCCEmailAddress}.
slots:
ComplianceBCCEmailAddress: requestBody.ComplianceBCCEmailAddress
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/email-config'].patch
update:
x-apievangelist-phrasing:
intent: Change existing email configuration
effect: write
questions:
- Can I change just the reply-to address on existing email settings?
- Is inbound email processing something I can toggle later?
instructions:
- text: Change the existing reply-to address to {ReplyToEmailAddress}.
slots:
ReplyToEmailAddress: requestBody.ReplyToEmailAddress
- text: Update email config so inbound processing is {ShouldProcessInbound}.
slots:
ShouldProcessInbound: requestBody.ShouldProcessInbound
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/product-settings'].get
update:
x-apievangelist-phrasing:
intent: Get custom configurations by name
effect: read
questions:
- Can I fetch several named product setting configurations at once?
- Which custom configurations exist for the settings I name?
instructions:
- text: Get product settings named {productSettingNames}.
slots:
productSettingNames: query.productSettingNames
- text: Fetch the custom configs {productSettingNames}.
slots:
productSettingNames: query.productSettingNames
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/product-settings'].post
update:
x-apievangelist-phrasing:
intent: Set a business object's custom configuration
effect: write
questions:
- How do I set the approval status field for a business object?
- Can I turn on rejection emails for one object's approvals?
instructions:
- text: Set the approval status field for {BusinessObject} to {ApprovalStatusField}.
slots:
BusinessObject: requestBody.BusinessObject
ApprovalStatusField: requestBody.ApprovalStatusField
- text: Enable rejection emails {EnableRejectionEmails} on {BusinessObject}.
slots:
EnableRejectionEmails: requestBody.EnableRejectionEmails
BusinessObject: requestBody.BusinessObject
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/product-settings/businessobjects'].get
update:
x-apievangelist-phrasing:
intent: Get product settings for all objects
effect: read
questions:
- What Approvals product settings are configured across every business object?
- Can I see all objects' product settings together?
instructions:
- text: Show Approvals product settings for all business objects.
- text: List every object's product setting configuration.
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/product-settings/{businessObject}'].get
update:
x-apievangelist-phrasing:
intent: Get one business object's custom configuration
effect: read
questions:
- What custom configuration is set for a specific business object?
- Is the rule engine callback enabled for this object?
instructions:
- text: Show the custom configuration for {businessObject}.
slots:
businessObject: path.businessObject
- text: Get product settings for the {businessObject} object.
slots:
businessObject: path.businessObject
method: generated
generated: '2026-10-01'
- target: $.paths['/v1/system-properties/product-settings/{businessObject}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a business object's custom configuration
effect: destructive
questions:
- Can I remove the custom configuration for one object?
- What happens when I delete an object's product setting config?
instructions:
- text: Delete the custom configuration for {businessObject}.
slots:
businessObject: path.businessObject
- text: Remove product settings on the {businessObject} object.
slots:
businessObject: path.businessObject
method: generated
generated: '2026-10-01'