# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Docusign Users API
  version: 1.0.0
extends: openapi/docusign-users-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: 22
- target: $.paths['/v2/organizations/{organizationId}/users/email_addresses'].post
  update:
    x-apievangelist-phrasing:
      intent: Change users' email addresses in an organization
      effect: write
      questions:
      - Can an org admin change the email address a DocuSign user signs in with?
      - What scope do I need to update member email addresses across my organization?
      instructions:
      - text: 'Update the email addresses for these users in organization {org}: {users}.'
        slots:
          org: path.organizationId
          users: requestBody.users
      - text: Change the login email of a user in org {org} to their new address.
        slots:
          org: path.organizationId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/organizations/{organizationId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users in an organization
      effect: read
      questions:
      - Which people belong to my DocuSign organization, across all its accounts?
      - Can I find organization members whose email matches a partial name?
      - How do I see org users modified since a certain date?
      instructions:
      - text: List the members of organization {org} in account {account_id}.
        slots:
          org: path.organizationId
          account_id: query.account_id
      - text: Find organization {org} users with email {email}.
        slots:
          org: path.organizationId
          email: query.email
      - text: Show users in org {org} changed since {since}.
        slots:
          org: path.organizationId
          since: query.last_modified_since
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List the users in an account
      effect: read
      questions:
      - Who are all the users on my eSignature account?
      - Can I filter account users by login status or group membership?
      - Which users in the account have an email containing a given substring?
      instructions:
      - text: List every user in account {account}.
        slots:
          account: path.accountId
      - text: Show users in account {account} whose email contains {sub}.
        slots:
          account: path.accountId
          sub: query.email_substring
      - text: List users of account {account} who are in group {grp}.
        slots:
          account: path.accountId
          grp: query.group_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users'].put
  update:
    x-apievangelist-phrasing:
      intent: Bulk-update several users in an account
      effect: write
      questions:
      - Can I change details for many account users in one request?
      - Is there a bulk endpoint to edit multiple users' settings at once?
      instructions:
      - text: 'Apply these changes to several users in account {account}: {users}.'
        slots:
          account: path.accountId
          users: requestBody.users
      - text: Bulk-update the user records in account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add new users to an account
      effect: write
      questions:
      - How do I add new users to my DocuSign account through the API?
      - What do I need to provide for each new user — just a name and email?
      instructions:
      - text: 'Add these new users to account {account}: {new_users}.'
        slots:
          account: path.accountId
          new_users: requestBody.newUsers
      - text: Create a user account for a new hire in account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users'].delete
  update:
    x-apievangelist-phrasing:
      intent: Close several user records in an account
      effect: destructive
      questions:
      - Can I close several user accounts at once so they can't use the account anymore?
      - Are closed users actually deleted from the account, or just deactivated?
      instructions:
      - text: 'Close these users in account {account}: {users}.'
        slots:
          account: path.accountId
          users: requestBody.users
      - text: Deactivate a batch of departed employees in account {account}.
        slots:
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's details
      effect: read
      questions:
      - How can I look up a specific user's profile and last login date?
      - Can I see when a user's password expires?
      instructions:
      - text: Get the details for user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: Show last login and password expiration for user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's profile information
      effect: write
      questions:
      - Can I change a user's name, job title or permission profile through the API?
      - What user profile fields can be edited after the user is created?
      instructions:
      - text: Update the job title of user {user} in account {account} to {title}.
        slots:
          user: path.userId
          account: path.accountId
          title: requestBody.jobTitle
      - text: Change user {user}'s permission profile in account {account} to {profile}.
        slots:
          user: path.userId
          account: path.accountId
          profile: requestBody.permissionProfileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a company account
      effect: destructive
      questions:
      - How do I remove a single member from a company account?
      - What permission do I need to remove a user with a lower access level?
      instructions:
      - text: Remove user {user} from company account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: Take {user} off the company account {account} entirely.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/profile/image'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's profile picture
      effect: read
      questions:
      - Where can I download a user's profile picture?
      - Is the profile image returned in the format it was uploaded in?
      instructions:
      - text: Download the profile image for user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: Fetch user {user}'s avatar from account {account} as base64.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/profile/image'].put
  update:
    x-apievangelist-phrasing:
      intent: Upload a user's profile picture
      effect: write
      questions:
      - What image formats and size limit apply to a user profile photo?
      - Can I replace my own profile picture via the API?
      instructions:
      - text: Upload a new profile image for user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: Set user {user}'s profile photo in account {account} to this PNG.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/profile/image'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user's profile picture
      effect: destructive
      questions:
      - Can I remove the profile photo from my user profile?
      - Does deleting a profile picture require being that same user?
      instructions:
      - text: Delete the profile image of user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: Clear user {user}'s avatar in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a user's settings and notification preferences
      effect: read
      questions:
      - Which email notifications is a particular user set to receive?
      - Where do I see a single user's account settings?
      instructions:
      - text: Show the settings for user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: List the email notification preferences of user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a user's settings and notifications
      effect: write
      questions:
      - Can I turn off signer email notifications for one user?
      - How do I change a user's sender notification settings?
      instructions:
      - text: Update user {user}'s sender email notifications in account {account} to {sender}.
        slots:
          user: path.userId
          account: path.accountId
          sender: requestBody.senderEmailNotifications
      - text: Change the user settings for {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/invite_user'].post
  update:
    x-apievangelist-phrasing:
      intent: Invite a new user to a company account
      effect: write
      questions:
      - How do I invite someone to join our Rooms company account with a specific role?
      - What's required when inviting a user — role, access level, default office?
      instructions:
      - text: Invite {first} {last} at {email} to account {account} with role {role}, access level {level}, office {office_id} and eSign profile {esign}.
        slots:
          first: requestBody.firstName
          last: requestBody.lastName
          email: requestBody.email
          account: path.accountId
          role: requestBody.roleId
          level: requestBody.accessLevel
          office_id: requestBody.defaultOfficeId
          esign: requestBody.eSignPermissionProfileId
      - text: Send a company invitation to {email} for account {account}, role {role}, level {level}, office {office_id}, eSign profile {esign}.
        slots:
          email: requestBody.email
          account: path.accountId
          role: requestBody.roleId
          level: requestBody.accessLevel
          office_id: requestBody.defaultOfficeId
          esign: requestBody.eSignPermissionProfileId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/reinvite'].post
  update:
    x-apievangelist-phrasing:
      intent: Resend an invitation to a pending user
      effect: write
      questions:
      - My user's invitation expired after 30 days — can I send them a new one?
      - Is there a way to resend an invite to someone who never activated?
      instructions:
      - text: Reinvite pending user {user} to account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: Resend the expired invitation for {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/add_to_office'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to an office
      effect: write
      questions:
      - How do I put an existing user into an office?
      - Can I add a user to multiple offices in one call?
      instructions:
      - text: Add user {user} to office {office_id} in account {account}.
        slots:
          user: path.userId
          office_id: requestBody.officeId
          account: path.accountId
      - text: Assign {user} to office {office_id} on account {account}.
        slots:
          user: path.userId
          office_id: requestBody.officeId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/remove_from_office'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from an office
      effect: destructive
      questions:
      - Can I take a user out of one office without affecting their other offices?
      - What happens to a user's region and company access when removed from an office?
      instructions:
      - text: Remove user {user} from office {office_id} in account {account}.
        slots:
          user: path.userId
          office_id: requestBody.officeId
          account: path.accountId
      - text: Take {user} out of office {office_id} on account {account}.
        slots:
          user: path.userId
          office_id: requestBody.officeId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/add_to_region'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a user to a region
      effect: write
      questions:
      - How can I add an existing user to a region?
      - Do I need a separate call for each region a user joins?
      instructions:
      - text: Add user {user} to region {region} in account {account}.
        slots:
          user: path.userId
          region: requestBody.regionId
          account: path.accountId
      - text: Put {user} in region {region} on account {account}.
        slots:
          user: path.userId
          region: requestBody.regionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/remove_from_region'].post
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from a region
      effect: destructive
      questions:
      - Can I remove a user from a single region but keep their company access?
      - Which call drops a member out of a region?
      instructions:
      - text: Remove user {user} from region {region} in account {account}.
        slots:
          user: path.userId
          region: requestBody.regionId
          account: path.accountId
      - text: Take {user} out of region {region} on account {account}.
        slots:
          user: path.userId
          region: requestBody.regionId
          account: path.accountId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/lock'].post
  update:
    x-apievangelist-phrasing:
      intent: Lock a user's account
      effect: write
      questions:
      - How do I lock a user out of the company account and record why?
      - Can I lock a user with a lower access level than mine?
      instructions:
      - text: Lock user {user} in account {account} because {reason}.
        slots:
          user: path.userId
          account: path.accountId
          reason: requestBody.reason
      - text: 'Suspend {user}''s access in account {account}, reason: {reason}.'
        slots:
          user: path.userId
          account: path.accountId
          reason: requestBody.reason
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/accounts/{accountId}/users/{userId}/unlock'].post
  update:
    x-apievangelist-phrasing:
      intent: Unlock a user's account
      effect: write
      questions:
      - How can a locked user regain access to the company account?
      - What permission is needed to unlock another member?
      instructions:
      - text: Unlock user {user} in account {account}.
        slots:
          user: path.userId
          account: path.accountId
      - text: Restore access for locked user {user} on account {account}.
        slots:
          user: path.userId
          account: path.accountId
      method: generated
      generated: '2026-10-01'