# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign Rooms API - v2 Form Groups API
  version: 1.0.0
extends: openapi/docusign-form-groups-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['/v2/accounts/{accountId}/form_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List form groups
      effect: read
      questions:
      - Which company form groups can I access?
      - How do I page through all form groups in a Rooms account?
      instructions:
      - text: List the form groups in account {account}.
        slots:
          account: path.accountId
      - text: Show the first {count} form groups for account {account}.
        slots:
          count: query.count
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a form group
      effect: write
      questions:
      - How do I create a new form group?
      - What permission is needed to set up form groups?
      instructions:
      - text: Create a form group called {name} in account {account}.
        slots:
          name: requestBody.name
          account: path.accountId
      - text: Add a new form group named {name} to account {account}.
        slots:
          name: requestBody.name
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a form group
      effect: read
      questions:
      - Can I fetch the details of a single form group?
      - What does a form group record contain?
      instructions:
      - text: Get form group {form_group} in account {account}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
      - text: Show details of form group {form_group} on account {account}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename a form group
      effect: write
      questions:
      - Is it possible to rename an existing form group?
      - Which call changes a form group's name?
      instructions:
      - text: Rename form group {form_group} in account {account} to {name}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
          name: requestBody.name
      - text: Change the name of form group {form_group} on account {account} to {name}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
          name: requestBody.name
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a form group
      effect: destructive
      questions:
      - How do I delete a form group?
      - Can a form group be removed permanently from the account?
      instructions:
      - text: Delete form group {form_group} from account {account}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
      - text: Remove the form group {form_group} in account {account}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}/forms'].get
  update:
    x-apievangelist-phrasing:
      intent: List the forms in a form group
      effect: read
      questions:
      - Which forms are in a given form group?
      - Can I page through the forms assigned to a form group?
      instructions:
      - text: List forms in form group {form_group} of account {account}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
      - text: Show which forms belong to form group {form_group} on account {account}.
        slots:
          form_group: path.formGroupId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}/unassign_form/{formId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a form from a form group
      effect: destructive
      questions:
      - Can I take one form out of a form group?
      - How do I unassign a form from a form group?
      instructions:
      - text: Remove form {form} from form group {form_group} in account {account}.
        slots:
          form: path.formId
          form_group: path.formGroupId
          account: path.accountId
      - text: Unassign form {form} from form group {form_group} on account {account}.
        slots:
          form: path.formId
          form_group: path.formGroupId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}/assign_form'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a form to a form group
      effect: write
      questions:
      - How do I assign a form to a form group?
      - Can I mark a form as required when adding it to a form group?
      instructions:
      - text: Assign form {form_id} to form group {form_group} in account {account}.
        slots:
          form_id: requestBody.formId
          form_group: path.formGroupId
          account: path.accountId
      - text: 'Add form {form_id} to form group {form_group} on account {account} as required: {required}.'
        slots:
          form_id: requestBody.formId
          form_group: path.formGroupId
          account: path.accountId
          required: requestBody.isRequired
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}/grant_office_access/{officeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Give an office access to a form group
      effect: write
      questions:
      - How can an office get access to a form group?
      - Can I share a form group with a specific office?
      instructions:
      - text: Grant office {office} access to form group {form_group} in account {account}.
        slots:
          office: path.officeId
          form_group: path.formGroupId
          account: path.accountId
      - text: Let office {office} use form group {form_group} on account {account}.
        slots:
          office: path.officeId
          form_group: path.formGroupId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/form_groups/{formGroupId}/revoke_office_access/{officeId}'].post
  update:
    x-apievangelist-phrasing:
      intent: Revoke an office's access to a form group
      effect: destructive
      questions:
      - Can I stop an office from using a form group?
      - How do I revoke office access to form group forms?
      instructions:
      - text: Revoke office {office}'s access to form group {form_group} in account {account}.
        slots:
          office: path.officeId
          form_group: path.formGroupId
          account: path.accountId
      - text: Remove form group {form_group} access from office {office} on account {account}.
        slots:
          form_group: path.formGroupId
          office: path.officeId
          account: path.accountId
      method: generated
      generated: '2026-10-01'