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.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for X-Author Alternate Clause API
version: 1.0.0
extends: openapi/conga-alternateclause-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: 3
- target: $.paths['/api/xauthor/v1/clauses/{clauseId}/alternates/link'].post
update:
x-apievangelist-phrasing:
intent: Link alternate clauses to a clause
effect: write
questions:
- How do I offer fallback alternate clauses for a standard clause?
- Can I attach several alternate clauses to one clause configuration?
instructions:
- text: Link alternate clauses {alternateClauseIds} to clause {clauseId}.
slots:
alternateClauseIds: requestBody.alternateClauseIds
clauseId: path.clauseId
- text: Add alternates {alternateClauseIds} to configuration {clauseConfigurationId} of clause {clauseId}.
slots:
alternateClauseIds: requestBody.alternateClauseIds
clauseConfigurationId: requestBody.clauseConfigurationId
clauseId: path.clauseId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/{clauseId}/alternates/{alternateclausemappingId}'].delete
update:
x-apievangelist-phrasing:
intent: Unlink an alternate clause
effect: destructive
questions:
- How do I stop offering an alternate clause for a clause?
- Can I unlink one alternate without deleting the clause itself?
instructions:
- text: Unlink alternate mapping {alternateclausemappingId} from clause {clauseId}.
slots:
alternateclausemappingId: path.alternateclausemappingId
clauseId: path.clauseId
- text: Remove alternate clause link {alternateclausemappingId} on clause {clauseId}.
slots:
alternateclausemappingId: path.alternateclausemappingId
clauseId: path.clauseId
method: generated
generated: '2026-10-01'
- target: $.paths['/api/xauthor/v1/clauses/{clauseId}/configurations/{configurationId}/alternates/re-order'].post
update:
x-apievangelist-phrasing:
intent: Reorder a clause's alternate clauses
effect: write
questions:
- Can I change the order in which alternate clauses are presented?
- How do I put the preferred alternate clause first?
instructions:
- text: Reorder alternates in configuration {configurationId} of clause {clauseId} as {alternateClauseIds}.
slots:
configurationId: path.configurationId
clauseId: path.clauseId
alternateClauseIds: requestBody.alternateClauseIds
- text: Change the alternate clause order for clause {clauseId}, configuration {configurationId}.
slots:
clauseId: path.clauseId
configurationId: path.configurationId
method: generated
generated: '2026-10-01'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
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.