Conga · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Contracts Bulk Import API

7 actions 7 updates phrasing extends openapi/conga-bulk-import-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.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/clm/v1/import/jobs'].post
$.paths['/api/clm/v1/import/jobs/query'].post
$.paths['/api/clm/v1/import/jobs/{jobId}'].get
$.paths['/api/clm/v1/import/jobs/{jobId}'].delete
$.paths['/api/clm/v1/import/jobs/{jobId}/batch/{batchId}'].get
$.paths['/api/clm/v1/import/templates/{format}'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Contracts Bulk Import API
  version: 1.0.0
extends: openapi/conga-bulk-import-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: 6
- target: $.paths['/api/clm/v1/import/jobs'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a bulk CSV import job
      effect: write
      questions:
      - How do I bulk-load accounts, contacts or agreements into Conga CLM from a CSV?
      - Can I upload a CSV file to create many CLM records at once?
      instructions:
      - text: Start a bulk import job with the CSV file {file}.
        slots:
          file: requestBody.file
      - text: Upload {file} to import contacts into CLM in bulk.
        slots:
          file: requestBody.file
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/import/jobs/query'].post
  update:
    x-apievangelist-phrasing:
      intent: List bulk import jobs
      effect: read
      questions:
      - Which bulk import jobs have been run so far?
      - Can I filter and sort the list of past CSV import jobs?
      instructions:
      - text: List my bulk import jobs.
      - text: Show the latest {limit} import jobs.
        slots:
          limit: requestBody.Limit
      - text: Find import jobs matching {criteria}.
        slots:
          criteria: requestBody.CriteriaExpression
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/import/jobs/{jobId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a bulk import job
      effect: read
      questions:
      - Did my bulk import job succeed or fail?
      - How do I check the outcome of a specific CSV import job?
      instructions:
      - text: Get the result of import job {job}.
        slots:
          job: path.jobId
      - text: Tell me whether bulk import {job} succeeded.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/import/jobs/{jobId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a bulk import job record
      effect: destructive
      questions:
      - Can I permanently remove the record of an old import job?
      - How do I clean up a bulk import job from the system?
      instructions:
      - text: Delete the import job record {job}.
        slots:
          job: path.jobId
      - text: Permanently remove bulk import job {job}.
        slots:
          job: path.jobId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/import/jobs/{jobId}/batch/{batchId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the file uploaded in an import batch
      effect: read
      questions:
      - How can I see what was in the CSV file uploaded for an import batch?
      - What contents were submitted in a given batch of a bulk import job?
      instructions:
      - text: Show the uploaded file for batch {batch} of import job {job}.
        slots:
          batch: path.batchId
          job: path.jobId
      - text: Fetch the contents submitted in job {job}, batch {batch}.
        slots:
          job: path.jobId
          batch: path.batchId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/clm/v1/import/templates/{format}'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a bulk import template
      effect: read
      questions:
      - Where do I get the CSV template needed to bulk-import agreements?
      - Which columns does the import template for contacts expect?
      instructions:
      - text: Get the {format} import template for {object}.
        slots:
          format: path.format
          object: query.objectName
      - text: Download the bulk import template in {format} format.
        slots:
          format: path.format
      method: generated
      generated: '2026-10-01'