# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Nylas Grant-level workflows API
  version: 1.0.0
extends: openapi/nylas-grant-level-workflows-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: 5
- target: $.paths['/v3/grants/{grant_id}/workflows'].get
  update:
    x-apievangelist-phrasing:
      intent: List a user's grant-level workflows
      effect: read
      questions:
      - Which automated email workflows are set up for one connected user?
      - How do I page through the workflows on a single grant?
      instructions:
      - text: List workflows for grant {grant_id}.
        slots:
          grant_id: path.grant_id
      - text: Show the first {limit} workflows on user {grant_id}.
        slots:
          limit: query.limit
          grant_id: path.grant_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/workflows'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a workflow for one connected user
      effect: write
      questions:
      - Can I set up an automated email for just one user's account when an event triggers?
      - Do I need a grant-level template before adding a user's workflow?
      instructions:
      - text: Create workflow {name} on grant {grant_id} sending template {template_id} on {trigger_event}.
        slots:
          name: requestBody.name
          grant_id: path.grant_id
          template_id: requestBody.template_id
          trigger_event: requestBody.trigger_event
      - text: For user {grant_id}, add workflow {name} that fires {template_id} after {trigger_event} with delay {delay}.
        slots:
          grant_id: path.grant_id
          name: requestBody.name
          template_id: requestBody.template_id
          trigger_event: requestBody.trigger_event
          delay: requestBody.delay
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/workflows/{workflow_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a user's workflow
      effect: read
      questions:
      - How can I view one workflow on a specific user's grant?
      - Can I check whether a user's workflow is enabled?
      instructions:
      - text: Get workflow {workflow_id} on grant {grant_id}.
        slots:
          workflow_id: path.workflow_id
          grant_id: path.grant_id
      - text: Show user {grant_id}'s workflow {workflow_id}.
        slots:
          grant_id: path.grant_id
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/workflows/{workflow_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit or pause a user's workflow
      effect: write
      questions:
      - Can I pause a workflow for one user without affecting others?
      - How do I change the trigger on a user's workflow?
      instructions:
      - text: Disable workflow {workflow_id} on grant {grant_id}.
        slots:
          workflow_id: path.workflow_id
          grant_id: path.grant_id
      - text: Change the trigger of user {grant_id}'s workflow {workflow_id} to {trigger_event}.
        slots:
          grant_id: path.grant_id
          workflow_id: path.workflow_id
          trigger_event: requestBody.trigger_event
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v3/grants/{grant_id}/workflows/{workflow_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a user's workflow
      effect: destructive
      questions:
      - How do I remove an automated workflow from one user's account?
      - Can I delete a grant-level workflow that's no longer needed?
      instructions:
      - text: Delete workflow {workflow_id} from grant {grant_id}.
        slots:
          workflow_id: path.workflow_id
          grant_id: path.grant_id
      - text: Remove user {grant_id}'s automated workflow {workflow_id}.
        slots:
          grant_id: path.grant_id
          workflow_id: path.workflow_id
      method: generated
      generated: '2026-09-26'