# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for DocuSign Admin User Import API
  version: 1.0.0
extends: openapi/docusign-userimport-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: 8
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users/add'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk import new users from CSV
      effect: write
      questions:
      - How do I add a batch of new users to my organization from a CSV file?
      - What columns does the CSV need to bulk create users?
      instructions:
      - text: Import new users from CSV {file} into organization {organization}.
        slots:
          file: requestBody.file.csv
          organization: path.organizationId
      - text: Bulk add the new users in {file} to organization {organization}.
        slots:
          file: requestBody.file.csv
          organization: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users/update'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk update existing users from CSV
      effect: write
      questions:
      - Can I update details for lots of existing users at once with a CSV?
      - How do I change job titles for many users in bulk?
      instructions:
      - text: Bulk update existing users in organization {organization} from CSV {file}.
        slots:
          organization: path.organizationId
          file: requestBody.file.csv
      - text: Apply profile changes in {file} to my existing users in organization {organization}.
        slots:
          file: requestBody.file.csv
          organization: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users/close'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk close user accounts
      effect: destructive
      questions:
      - How do I close a list of users' accounts in one go?
      - Can I deactivate many users at once instead of deleting them one by one?
      instructions:
      - text: Create a request to close user accounts in organization {organization}.
        slots:
          organization: path.organizationId
      - text: Bulk close the accounts of users listed in my CSV for organization {organization}.
        slots:
          organization: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users/close_external'].post
  update:
    x-apievangelist-phrasing:
      intent: Close external memberships
      effect: destructive
      questions:
      - How do I remove users on my verified domain who don't belong to my organization?
      - What counts as an external membership?
      instructions:
      - text: Close external memberships for organization {organization}.
        slots:
          organization: path.organizationId
      - text: Remove outside users on our verified domains from organization {organization}.
        slots:
          organization: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users'].get
  update:
    x-apievangelist-phrasing:
      intent: List user import requests
      effect: read
      questions:
      - Which bulk user imports have been run for my organization?
      - Can I see all past user import requests?
      instructions:
      - text: List all user import requests for organization {organization}.
        slots:
          organization: path.organizationId
      - text: Show past bulk user imports in organization {organization}.
        slots:
          organization: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users/{importId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a user import request's status
      effect: read
      questions:
      - Has my bulk user import finished processing?
      - How do I check the status of one import request?
      instructions:
      - text: Get the status of import {import} in organization {organization}.
        slots:
          import: path.importId
          organization: path.organizationId
      - text: Tell me if user import {import} has completed.
        slots:
          import: path.importId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users/{importId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user import request
      effect: destructive
      questions:
      - Can I delete an old import request and its results?
      - How do I clean up a user import record I no longer need?
      instructions:
      - text: Delete import request {import} from organization {organization}.
        slots:
          import: path.importId
          organization: path.organizationId
      - text: Remove user import {import} and its results.
        slots:
          import: path.importId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/imports/bulk_users/{importId}/results_csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download a user import's CSV results
      effect: read
      questions:
      - Where can I see which rows of my user import failed?
      - Can I download the processed CSV with per-row results?
      instructions:
      - text: Download the CSV results of import {import} in organization {organization}.
        slots:
          import: path.importId
          organization: path.organizationId
      - text: Show which rows of user import {import} failed.
        slots:
          import: path.importId
      method: generated
      generated: '2026-10-01'