API Evangelist conversational phrasing for Clickup Custom Fields API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Clickup Custom Fields API
  version: 1.0.0
extends: openapi/clickup-custom-fields-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: 9
- target: $.paths['/v2/list/{list_id}/field'].get
  update:
    x-apievangelist-phrasing:
      intent: List a List's Custom Fields (v2)
      effect: read
      questions:
      - Which Custom Fields can I use on tasks in a particular List?
      - Can I see which custom task types each List field applies to in v2?
      instructions:
      - text: Show the v2 Custom Fields available on List {list_id}.
        slots:
          list_id: path.list_id
      - text: 'List List {list_id}''s Custom Fields with applied objects: {include_applied_objects}.'
        slots:
          list_id: path.list_id
          include_applied_objects: query.include_applied_objects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/folder/{folder_id}/field'].get
  update:
    x-apievangelist-phrasing:
      intent: List Folder-level Custom Fields
      effect: read
      questions:
      - What Custom Fields were created at the Folder level?
      - Does the Folder fields call include fields defined on individual Lists?
      instructions:
      - text: Show the Custom Fields created on Folder {folder_id}.
        slots:
          folder_id: path.folder_id
      - text: List Folder {folder_id}'s own fields with applied objects {include_applied_objects}.
        slots:
          folder_id: path.folder_id
          include_applied_objects: query.include_applied_objects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/space/{space_id}/field'].get
  update:
    x-apievangelist-phrasing:
      intent: List Space-level Custom Fields
      effect: read
      questions:
      - Which Custom Fields are defined for a whole Space?
      - Are Folder and List fields excluded when I ask for a Space's fields?
      instructions:
      - text: Show the Custom Fields created on Space {space_id}.
        slots:
          space_id: path.space_id
      - text: List Space {space_id}'s own field definitions, applied objects {include_applied_objects}.
        slots:
          space_id: path.space_id
          include_applied_objects: query.include_applied_objects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/team/{team_id}/field'].get
  update:
    x-apievangelist-phrasing:
      intent: List Workspace-level Custom Fields
      effect: read
      questions:
      - What Custom Fields exist at the Workspace level in ClickUp?
      - Can I find fields scoped to custom task types across my Workspace?
      instructions:
      - text: Show the Custom Fields created at the Workspace level of {team_id}.
        slots:
          team_id: path.team_id
      - text: List Workspace {team_id}'s global fields with applied objects {include_applied_objects}.
        slots:
          team_id: path.team_id
          include_applied_objects: query.include_applied_objects
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/task/{task_id}/field/{field_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a Custom Field on a task (v2)
      effect: write
      questions:
      - How do I fill in a Custom Field on a task through the v2 API?
      - Can I address the task by its custom task ID when setting a field value in v2?
      instructions:
      - text: Using v2, set Custom Field {field_id} on task {task_id}.
        slots:
          field_id: path.field_id
          task_id: path.task_id
      - text: Fill in field {field_id} for custom task ID {task_id} in Workspace {team_id} via v2.
        slots:
          field_id: path.field_id
          task_id: path.task_id
          team_id: query.team_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v2/task/{task_id}/field/{field_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear a Custom Field on a task (v2)
      effect: destructive
      questions:
      - Can I clear a task's Custom Field without deleting the dropdown option itself?
      - What does removing a field value do in v2?
      instructions:
      - text: Using v2, clear Custom Field {field_id} on task {task_id}.
        slots:
          field_id: path.field_id
          task_id: path.task_id
      - text: Blank out the v2 value of field {field_id} for task {task_id}.
        slots:
          field_id: path.field_id
          task_id: path.task_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/list/{list_id}/field'].get
  update:
    x-apievangelist-phrasing:
      intent: List a List's Custom Fields (legacy path)
      effect: read
      questions:
      - On the older unversioned path, what field definitions and dropdown options does a List expose?
      - Does the legacy endpoint include label field values?
      instructions:
      - text: On the legacy path, fetch field definitions and dropdown options for List {list_id}.
        slots:
          list_id: path.list_id
      - text: Using the older endpoint, enumerate the custom fields usable in {list_id}.
        slots:
          list_id: path.list_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task/{task_id}/field/{field_id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set a Custom Field value (legacy path)
      effect: write
      questions:
      - On the older unversioned path, what format does a dropdown field value take?
      - Can the legacy endpoint set label fields with an array of label IDs?
      instructions:
      - text: On the legacy path, put {value} into field {field_id} of task {task_id}.
        slots:
          value: requestBody.value
          field_id: path.field_id
          task_id: path.task_id
      - text: Using the older endpoint, write {value} to custom field {field_id} on {task_id}.
        slots:
          value: requestBody.value
          field_id: path.field_id
          task_id: path.task_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/task/{task_id}/field/{field_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Reset a Custom Field value (legacy path)
      effect: destructive
      questions:
      - On the older unversioned path, how is a task's field reset to empty?
      - Does the legacy reset call work with custom task IDs?
      instructions:
      - text: On the legacy path, reset field {field_id} on task {task_id} to empty.
        slots:
          field_id: path.field_id
          task_id: path.task_id
      - text: Using the older endpoint, empty custom field {field_id} of {task_id}.
        slots:
          field_id: path.field_id
          task_id: path.task_id
      method: generated
      generated: '2026-09-26'