# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for User Provisioning Users API
  version: 1.0.0
extends: openapi/hubspot-users-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/settings/users/2026-03/{userId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a user in the account
      effect: read
      questions:
      - Which role and teams does a given user in my HubSpot account have?
      - Can I find a user by email address instead of by user ID?
      instructions:
      - text: Get user {userId}.
        slots:
          userId: path.userId
      - text: Look up the user whose email is {userId}, treating it as {idProperty}.
        slots:
          userId: path.userId
          idProperty: query.idProperty
      method: generated
      generated: '2026-09-24'
- target: $.paths['/settings/users/2026-03/{userId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a user's name, role or teams
      effect: write
      questions:
      - How do I change a user's role through the API?
      - Can I move a user onto a different primary team?
      - What user details can be edited, such as first and last name?
      instructions:
      - text: Give user {userId} the role {roleId}.
        slots:
          userId: path.userId
          roleId: requestBody.roleId
      - text: Make {primaryTeamId} the primary team for user {userId}.
        slots:
          primaryTeamId: requestBody.primaryTeamId
          userId: path.userId
      - text: Rename user {userId} to {firstName} {lastName}.
        slots:
          userId: path.userId
          firstName: requestBody.firstName
          lastName: requestBody.lastName
      method: generated
      generated: '2026-09-24'
- target: $.paths['/settings/users/2026-03/{userId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a user from the account
      effect: destructive
      questions:
      - Someone left the company; can I remove their user seat through the API?
      - Can I remove a user by their email rather than their ID?
      instructions:
      - text: Remove user {userId} from the account.
        slots:
          userId: path.userId
      - text: Offboard the user with email {userId}, identified by {idProperty}.
        slots:
          userId: path.userId
          idProperty: query.idProperty
      method: generated
      generated: '2026-09-24'