# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Zoho Crm Users API
  version: 1.0.0
extends: openapi/zoho-crm-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 18
- target: $.paths['/users/{user}/actions/associated_groups'].get
  update:
    x-apievangelist-phrasing:
      intent: List the user groups a user belongs to
      effect: read
      questions:
      - Which user groups is a particular CRM user a member of?
      - Can I page through the groups one user is associated with?
      instructions:
      - text: Show the user groups that user {user} belongs to.
        slots:
          user: path.user
      - text: List page {page} of groups associated with user {user}, {per_page} per page.
        slots:
          page: query.page
          user: path.user
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].get
  update:
    x-apievangelist-phrasing:
      intent: List users in the organization
      effect: read
      questions:
      - How do I get a list of every user in my Zoho CRM organization?
      - Can I filter the org's user list by type, such as active or deactivated users?
      instructions:
      - text: List all users in my CRM organization.
      - text: List CRM users of type {type}.
        slots:
          type: query.type
      - text: Show page {page} of the organization's users with {per_page} per page.
        slots:
          page: query.page
          per_page: query.per_page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].put
  update:
    x-apievangelist-phrasing:
      intent: Update several users at once
      effect: write
      questions:
      - Can I update the details of multiple CRM users in a single request?
      - What's the way to bulk-edit several users' profiles or roles together?
      instructions:
      - text: 'Apply these changes to multiple users in one batch: {users}.'
        slots:
          users: requestBody.users
      - text: Bulk update the listed users' roles and profiles.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a new user to the organization
      effect: write
      questions:
      - How do I add a new teammate as a user in the CRM?
      - What details do I need to invite a new user into my organization?
      instructions:
      - text: 'Create a new CRM user with these details: {users}.'
        slots:
          users: requestBody.users
      - text: Add a new user to our organization.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one user's details
      effect: read
      questions:
      - Where can I look up the profile, role and status of one specific user by ID?
      - What information does the CRM keep about an individual user?
      instructions:
      - text: Get the details of user {user}.
        slots:
          user: path.user
      - text: Show me the role and profile for user ID {user}.
        slots:
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a single user by ID
      effect: write
      questions:
      - Can I change one user's role or profile using their user ID?
      - Is there a way to edit just one user's details without a bulk update?
      instructions:
      - text: 'Update user {user} with these changes: {users}.'
        slots:
          user: path.user
          users: requestBody.users
      - text: Change the details of only user {user}.
        slots:
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user
      effect: destructive
      questions:
      - How do I remove a user from the CRM organization for good?
      - Can I delete a user account directly by its ID?
      instructions:
      - text: Delete user {user} from the organization.
        slots:
          user: path.user
      - text: Remove CRM user {user}.
        slots:
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}/territories'].get
  update:
    x-apievangelist-phrasing:
      intent: List territories assigned to a user
      effect: read
      questions:
      - Which sales territories are assigned to a given user?
      - Can I see all the territories a rep currently covers?
      instructions:
      - text: List all territories assigned to user {user}.
        slots:
          user: path.user
      - text: Show which territories user {user} covers.
        slots:
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}/territories'].put
  update:
    x-apievangelist-phrasing:
      intent: Assign territories to a user
      effect: write
      questions:
      - How do I assign one or more territories to a sales rep?
      - Can I add several territories to a user at the same time?
      instructions:
      - text: Assign territories {territories} to user {user}.
        slots:
          territories: requestBody.territories
          user: path.user
      - text: 'Associate these territories with user {user}: {territories}.'
        slots:
          user: path.user
          territories: requestBody.territories
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}/territories'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove several territories from a user
      effect: destructive
      questions:
      - Can I unassign multiple territories from a user in one call?
      - What's the way to strip a batch of territories off a rep's assignment?
      instructions:
      - text: Remove territories {ids} from user {user}.
        slots:
          ids: query.ids
          user: path.user
      - text: Unassign the territories with IDs {ids} from user {user}.
        slots:
          ids: query.ids
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}/territories/{territory}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one territory assigned to a user
      effect: read
      questions:
      - Is a particular territory assigned to a specific user, and what are its details?
      - Can I check one territory assignment for a user rather than listing them all?
      instructions:
      - text: Show territory {territory} as assigned to user {user}.
        slots:
          territory: path.territory
          user: path.user
      - text: Check whether user {user} has territory {territory}.
        slots:
          user: path.user
          territory: path.territory
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{user}/territories/{territory}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove one territory from a user
      effect: destructive
      questions:
      - How do I take a single territory away from a user?
      - Can I unassign just one territory from a rep without touching the others?
      instructions:
      - text: Remove territory {territory} from user {user}.
        slots:
          territory: path.territory
          user: path.user
      - text: Unassign only territory {territory} from user {user}.
        slots:
          territory: path.territory
          user: path.user
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}/actions/transfer_and_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer a user's records and then delete the user
      effect: destructive
      questions:
      - How do I hand off a departing user's records to someone else and delete their account?
      - Can I transfer a user's assignments and criteria before deleting that specific user?
      instructions:
      - text: Transfer everything owned by user {userId} and then delete them, using {transfer_and_delete}.
        slots:
          userId: path.userId
          transfer_and_delete: requestBody.transfer_and_delete
      - text: Move user {userId}'s records to another user and delete user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/actions/transfer_and_delete'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a transfer-and-delete job's status
      effect: read
      questions:
      - Has the job that transfers a user's records and deletes them finished yet?
      - Where do I check progress on a transfer-and-delete job?
      instructions:
      - text: Check the status of transfer-and-delete job {job_id}.
        slots:
          job_id: query.job_id
      - text: Tell me whether user deletion job {job_id} has completed.
        slots:
          job_id: query.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/actions/transfer_and_delete'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer and delete users in a batch
      effect: destructive
      questions:
      - Can I transfer records from several users and delete all of them in one request?
      - Is there a bulk transfer-and-delete that takes the users in the request body instead of the URL?
      instructions:
      - text: 'Run a batch transfer-and-delete for these users: {transfer_and_delete}.'
        slots:
          transfer_and_delete: requestBody.transfer_and_delete
      - text: 'Transfer the records of multiple departing users and delete them all: {transfer_and_delete}.'
        slots:
          transfer_and_delete: requestBody.transfer_and_delete
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}/actions/transfer'].post
  update:
    x-apievangelist-phrasing:
      intent: Transfer a user's records without deleting them
      effect: write
      questions:
      - Can I reassign a user's records and assignments to someone else but keep the user active?
      - What's the way to move one user's ownership to a colleague without deleting their account?
      instructions:
      - text: Transfer user {userId}'s records to another user without deleting them, using {transfer}.
        slots:
          userId: path.userId
          transfer: requestBody.transfer
      - text: Hand over user {userId}'s assignments and criteria but keep the account.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/actions/transfer'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a transfer-only job's status
      effect: read
      questions:
      - Has my records-only user transfer job (no deletion) finished?
      - Where can I see the progress of a transfer job that keeps the user?
      instructions:
      - text: Check the status of transfer-only job {job_id}.
        slots:
          job_id: query.job_id
      - text: Show progress for user transfer job {job_id} that does not delete the user.
        slots:
          job_id: query.job_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/users/{userId}/actions/validate_before_transfer'].get
  update:
    x-apievangelist-phrasing:
      intent: Validate a user before transferring them
      effect: read
      questions:
      - Can I check whether a user is ready to be transferred before I start the transfer?
      - Is there a pre-transfer validation I can run on a specific user?
      instructions:
      - text: Validate user {userId} before transferring their records.
        slots:
          userId: path.userId
      - text: Run the pre-transfer check for user {userId}.
        slots:
          userId: path.userId
      method: generated
      generated: '2026-09-26'