# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Conga Sign Custom Fields API
  version: 1.0.0
extends: openapi/conga-custom-fields-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: 5
- target: $.paths['/v1/cs-account/customfields'].get
  update:
    x-apievangelist-phrasing:
      intent: List account custom fields
      effect: read
      questions:
      - Which custom fields are defined on my Conga Sign account?
      - Can I page through custom fields?
      instructions:
      - text: List all account custom fields.
      - text: Show every custom field on the account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/customfields'].put
  update:
    x-apievangelist-phrasing:
      intent: Update an account custom field
      effect: write
      questions:
      - Can I change the value or translations of an existing custom field?
      - Is it possible to make an existing custom field required?
      instructions:
      - text: Update custom field {id} to value {value}.
        slots:
          id: requestBody.id
          value: requestBody.value
      - text: Set existing custom field {id} required to {required}.
        slots:
          id: requestBody.id
          required: requestBody.required
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/customfields'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an account custom field
      effect: write
      questions:
      - How do I add a new custom field to my account?
      - Can a new custom field have translations?
      instructions:
      - text: Create a custom field named {name} with value {value}.
        slots:
          name: requestBody.name
          value: requestBody.value
      - text: Add new custom field {id} with translations {translations}.
        slots:
          id: requestBody.id
          translations: requestBody.translations
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/customfields/{customFieldId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an account custom field
      effect: read
      questions:
      - What is configured on one custom field?
      - Can I fetch a custom field by its ID?
      instructions:
      - text: Show custom field {customFieldId}.
        slots:
          customFieldId: path.customFieldId
      - text: Get the details of custom field {customFieldId}.
        slots:
          customFieldId: path.customFieldId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/cs-account/customfields/{customFieldId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an account custom field
      effect: destructive
      questions:
      - Can I remove a custom field from my account?
      - What call deletes a custom field by ID?
      instructions:
      - text: Delete custom field {customFieldId}.
        slots:
          customFieldId: path.customFieldId
      - text: Remove the account custom field {customFieldId}.
        slots:
          customFieldId: path.customFieldId
      method: generated
      generated: '2026-10-01'