# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Merge Subpackage Field Mapping API
  version: 1.0.0
extends: openapi/merge-subpackage-fieldmapping-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: 50
- target: $.paths['/accounting/v1/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on an accounting linked account
      effect: read
      questions:
      - Which custom field mappings are set up on my customer's accounting connection?
      - Can I see how remote accounting fields map onto my own Merge fields?
      instructions:
      - text: Show every field mapping on the accounting linked account with token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: List accounting field mappings without the remote field metadata {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/field-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a remote accounting field to a target field
      effect: write
      questions:
      - How do I pull a custom field out of a customer's accounting system into a common model?
      - Does adding an accounting field mapping force a full resync of the ledger data?
      instructions:
      - text: Map the remote accounting field at {remote_field_traversal_path} from {remote_method} {remote_url_path} onto {common_model_name}.
        slots:
          remote_field_traversal_path: requestBody.remote_field_traversal_path
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          common_model_name: requestBody.common_model_name
      - text: Create accounting target field {target_field_name} on {common_model_name} fed from {remote_url_path} via {remote_method} at path {remote_field_traversal_path}.
        slots:
          target_field_name: requestBody.target_field_name
          common_model_name: requestBody.common_model_name
          remote_url_path: requestBody.remote_url_path
          remote_method: requestBody.remote_method
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/field-mappings/{field_mapping_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an accounting field mapping
      effect: destructive
      questions:
      - What happens to synced ledger data when I remove an accounting field mapping?
      - Can I drop a custom mapping from one customer's accounting connection?
      instructions:
      - text: Delete accounting field mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      - text: Remove mapping {field_mapping_id} from the bookkeeping integration and its mapped data.
        slots:
          field_mapping_id: path.field_mapping_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/field-mappings/{field_mapping_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing accounting field mapping
      effect: write
      questions:
      - Can I repoint an accounting field mapping at a different remote endpoint?
      - Is it possible to edit the JMESPath on a ledger field mapping I already made?
      instructions:
      - text: Point accounting field mapping {field_mapping_id} at remote path {remote_url_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_url_path: requestBody.remote_url_path
      - text: Set the JMES path of accounting mapping {field_mapping_id} to {jmes_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          jmes_path: requestBody.jmes_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/remote-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote fields available from an accounting integration
      effect: read
      questions:
      - Which raw fields does my customer's accounting platform expose that I could map?
      - Can I get example values for the remote fields on accounting invoices?
      instructions:
      - text: List remote accounting fields for the {common_models} models.
        slots:
          common_models: query.common_models
      - text: Show accounting remote fields with example values {include_example_values}.
        slots:
          include_example_values: query.include_example_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/target-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide accounting target fields
      effect: read
      questions:
      - What organization-wide target fields have we defined for accounting data?
      - Which custom accounting fields apply across all of our linked accounts?
      instructions:
      - text: List our org-wide accounting target fields using account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show every accounting target field our organization has defined.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/target-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new accounting target field
      effect: write
      questions:
      - How do I add a custom field to accounting data for every customer at once?
      - Can I describe what a new org-wide accounting target field is for?
      instructions:
      - text: Create accounting target field {name} on the {common_model} model.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
      - text: Add an org-wide accounting field {name} to {common_model} described as {description}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on a recruiting linked account
      effect: read
      questions:
      - What field mappings exist on this customer's applicant tracking connection?
      - Which candidate and job fields have been custom-mapped for this ATS integration?
      instructions:
      - text: Get the ATS field mappings for linked account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Fetch recruiting field mappings, excluding remote metadata {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/field-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a remote ATS field to a target field
      effect: write
      questions:
      - Can I bring a custom candidate field from an applicant tracking system into my data?
      - Will a new recruiting field mapping resync every job and candidate from scratch?
      instructions:
      - text: Create an ATS mapping from {remote_method} {remote_url_path} field {remote_field_traversal_path} into model {common_model_name}.
        slots:
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          remote_field_traversal_path: requestBody.remote_field_traversal_path
          common_model_name: requestBody.common_model_name
      - text: Add recruiting field {target_field_name} to {common_model_name}, sourced from {remote_field_traversal_path} on {remote_method} {remote_url_path}.
        slots:
          target_field_name: requestBody.target_field_name
          common_model_name: requestBody.common_model_name
          remote_field_traversal_path: requestBody.remote_field_traversal_path
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/field-mappings/{field_mapping_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a recruiting field mapping
      effect: destructive
      questions:
      - If I delete an ATS field mapping, is the candidate data it pulled removed too?
      - How can I get rid of a recruiting field mapping I no longer need?
      instructions:
      - text: Delete ATS field mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      - text: Tear down the applicant tracking mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/field-mappings/{field_mapping_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing ATS field mapping
      effect: write
      questions:
      - Can I change which remote candidate field an existing ATS mapping reads?
      - Is there a way to edit the HTTP method on a recruiting field mapping?
      instructions:
      - text: Update ATS mapping {field_mapping_id} to read {remote_field_traversal_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      - text: Switch recruiting mapping {field_mapping_id} to use remote method {remote_method}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_method: requestBody.remote_method
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/remote-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote fields available from an ATS integration
      effect: read
      questions:
      - What third-party candidate fields could I map from this applicant tracking system?
      - Does the ATS remote field list show sample values?
      instructions:
      - text: List the ATS remote fields for common models {common_models}.
        slots:
          common_models: query.common_models
      - text: Show recruiting remote fields including example values {include_example_values}.
        slots:
          include_example_values: query.include_example_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/target-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide ATS target fields
      effect: read
      questions:
      - Which organization-level custom fields have we set up for recruiting data?
      - Where do I see the ATS target fields shared by all our customers?
      instructions:
      - text: Show the ATS target fields for the linked account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: List our organization's recruiting target fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ats/v1/target-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new ATS target field
      effect: write
      questions:
      - Can I define a custom recruiting field that applies to every linked ATS?
      - What do I need to create an organization-wide candidate or job target field?
      instructions:
      - text: Create an ATS target field {name} on {common_model}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
      - text: Define recruiting field {name} for model {common_model} with the note {description}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on a chat linked account
      effect: read
      questions:
      - Which field mappings are configured on my customer's chat integration?
      - Can I review the custom mappings for messages and conversations from a chat tool?
      instructions:
      - text: List chat field mappings for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Pull the chat integration's field mappings, remote metadata excluded {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/field-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a remote chat field to a target field
      effect: write
      questions:
      - How can I sync a custom field from a chat platform's messages into my model?
      - Does creating a chat field mapping trigger a complete resync of conversations?
      instructions:
      - text: Map chat remote field {remote_field_traversal_path} from {remote_method} {remote_url_path} to {common_model_name}.
        slots:
          remote_field_traversal_path: requestBody.remote_field_traversal_path
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          common_model_name: requestBody.common_model_name
      - text: Add chat target {target_field_name} on {common_model_name} fed by {remote_method} {remote_url_path} path {remote_field_traversal_path}.
        slots:
          target_field_name: requestBody.target_field_name
          common_model_name: requestBody.common_model_name
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/field-mappings/{field_mapping_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a chat field mapping
      effect: destructive
      questions:
      - Can I remove a custom field mapping from a chat integration?
      - Does deleting a chat mapping also wipe the message data it synced?
      instructions:
      - text: Delete chat field mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      - text: Get rid of the messaging mapping {field_mapping_id} on this chat connection.
        slots:
          field_mapping_id: path.field_mapping_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/field-mappings/{field_mapping_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing chat field mapping
      effect: write
      questions:
      - Can I edit where a chat field mapping reads its value from?
      - Is an advanced mapping expression supported when updating a chat mapping?
      instructions:
      - text: Change chat mapping {field_mapping_id} to remote URL path {remote_url_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_url_path: requestBody.remote_url_path
      - text: Apply advanced expression {advanced_mapping_expression} to chat mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
          advanced_mapping_expression: requestBody.advanced_mapping_expression
      method: generated
      generated: '2026-09-26'
- target: $.paths['/remote-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote fields available from a chat integration
      effect: read
      questions:
      - What raw message and conversation fields does a customer's chat tool expose?
      - Can I filter the chat remote fields to one common model?
      instructions:
      - text: List chat remote fields for models {common_models}.
        slots:
          common_models: query.common_models
      - text: Show the chat integration's remote fields with samples {include_example_values}.
        slots:
          include_example_values: query.include_example_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/target-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide chat target fields
      effect: read
      questions:
      - Which org-wide custom fields have we defined for chat data?
      - Where are the chat target fields that every linked account shares?
      instructions:
      - text: List chat target fields via account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show all organization-wide chat target fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/target-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new chat target field
      effect: write
      questions:
      - Can I add a custom chat field that every customer's integration can map to?
      - What's needed to define an org-wide target field on chat messages?
      instructions:
      - text: Create chat target field {name} on model {common_model}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
      - text: Define an org-wide chat field {name} for {common_model}, explained as {description}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on a CRM linked account
      effect: read
      questions:
      - Which custom CRM fields are mapped for this customer's sales system?
      - Can I audit the field mappings on a CRM connection in Merge?
      instructions:
      - text: List CRM field mappings for linked account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Return the CRM field mappings with remote metadata excluded {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/field-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a remote CRM field to a target field
      effect: write
      questions:
      - How do I sync a custom contact or deal field from a customer's CRM?
      - Will a new CRM field mapping resync all accounts and opportunities from the start?
      instructions:
      - text: Map CRM field {remote_field_traversal_path} returned by {remote_method} {remote_url_path} into {common_model_name}.
        slots:
          remote_field_traversal_path: requestBody.remote_field_traversal_path
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          common_model_name: requestBody.common_model_name
      - text: Create CRM target {target_field_name} for {common_model_name} from {remote_method} {remote_url_path} at {remote_field_traversal_path}.
        slots:
          target_field_name: requestBody.target_field_name
          common_model_name: requestBody.common_model_name
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/field-mappings/{field_mapping_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a CRM field mapping
      effect: destructive
      questions:
      - How can I unmap a custom CRM field for one customer?
      - Is the synced sales data deleted when a CRM field mapping goes away?
      instructions:
      - text: Delete CRM field mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      - text: Remove the sales CRM mapping {field_mapping_id} along with its mapped values.
        slots:
          field_mapping_id: path.field_mapping_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/field-mappings/{field_mapping_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing CRM field mapping
      effect: write
      questions:
      - Can I fix the remote path on a CRM field mapping without recreating it?
      - Is it possible to change a CRM mapping's JMESPath expression?
      instructions:
      - text: Edit CRM mapping {field_mapping_id} so it reads {remote_field_traversal_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      - text: Give CRM mapping {field_mapping_id} the JMES path {jmes_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          jmes_path: requestBody.jmes_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/remote-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote fields available from a CRM integration
      effect: read
      questions:
      - What custom fields in my customer's CRM are available to map?
      - Can I see example values for remote CRM contact fields?
      instructions:
      - text: List CRM remote fields for {common_models}.
        slots:
          common_models: query.common_models
      - text: Show the sales CRM's remote fields and their example values {include_example_values}.
        slots:
          include_example_values: query.include_example_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/target-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide CRM target fields
      effect: read
      questions:
      - Which CRM target fields has our organization defined for every customer?
      - What org-level custom CRM fields exist today?
      instructions:
      - text: Show CRM target fields for account token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: List our organization-wide CRM target fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crm/v1/target-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new CRM target field
      effect: write
      questions:
      - Can I create one custom CRM field, like lead score, for all linked accounts?
      - How is an org-wide CRM target field attached to a common model?
      instructions:
      - text: Create CRM target field {name} on {common_model}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
      - text: Define org-wide CRM field {name} for {common_model} with description {description}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on a file storage linked account
      effect: read
      questions:
      - Which custom file and folder fields are mapped on this storage connection?
      - Can I list the field mappings for a customer's file storage integration?
      instructions:
      - text: List file storage field mappings for token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Get storage field mappings, leaving out remote metadata {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/field-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a remote file storage field to a target field
      effect: write
      questions:
      - How can I pull a custom file attribute from a storage provider into my model?
      - Does a new file storage mapping make every file and folder resync?
      instructions:
      - text: Map storage field {remote_field_traversal_path} from {remote_method} {remote_url_path} onto {common_model_name}.
        slots:
          remote_field_traversal_path: requestBody.remote_field_traversal_path
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          common_model_name: requestBody.common_model_name
      - text: Create file storage target {target_field_name} on {common_model_name} using {remote_method} {remote_url_path} and path {remote_field_traversal_path}.
        slots:
          target_field_name: requestBody.target_field_name
          common_model_name: requestBody.common_model_name
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/field-mappings/{field_mapping_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a file storage field mapping
      effect: destructive
      questions:
      - Can I delete a custom mapping on a file storage connection?
      - What happens to file metadata synced by a storage mapping once it is deleted?
      instructions:
      - text: Delete file storage field mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      - text: Drop storage mapping {field_mapping_id} for files and folders.
        slots:
          field_mapping_id: path.field_mapping_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/field-mappings/{field_mapping_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing file storage field mapping
      effect: write
      questions:
      - Can I retarget a file storage mapping to another remote endpoint?
      - How do I tweak the traversal path of a storage field mapping?
      instructions:
      - text: Update storage mapping {field_mapping_id} to call {remote_url_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_url_path: requestBody.remote_url_path
      - text: Change the traversal path on file storage mapping {field_mapping_id} to {remote_field_traversal_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/remote-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote fields available from a file storage integration
      effect: read
      questions:
      - What remote file and drive fields can I map from a storage provider?
      - Can I see sample values for file storage remote fields?
      instructions:
      - text: List file storage remote fields for {common_models}.
        slots:
          common_models: query.common_models
      - text: Show storage remote fields with example values {include_example_values}.
        slots:
          include_example_values: query.include_example_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/target-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide file storage target fields
      effect: read
      questions:
      - Which org-wide target fields have we defined for files and folders?
      - Where can I find our file storage target field definitions?
      instructions:
      - text: List file storage target fields using token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show every organization-wide target field for file storage.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filestorage/v1/target-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new file storage target field
      effect: write
      questions:
      - Can I add a custom field to files or folders for all customers at once?
      - What do I pass to create an org-wide file storage target field?
      instructions:
      - text: Create file storage target field {name} on {common_model}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
      - text: Add storage field {name} to the {common_model} model, described {description}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on an HRIS linked account
      effect: read
      questions:
      - Which custom employee fields are mapped on this customer's HR system?
      - Can I review the HRIS field mappings for a payroll or HR connection?
      instructions:
      - text: List HRIS field mappings for token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Fetch HR field mappings without remote metadata {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/hris/v1/target-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new HRIS target field
      effect: write
      questions:
      - Can I define a custom employee field that every HR integration maps into?
      - How is an organization-wide HRIS target field created?
      instructions:
      - text: Create HRIS target field {name} on {common_model}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
      - text: Define HR field {name} for model {common_model} with description {description}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on a knowledge base linked account
      effect: read
      questions:
      - Which article fields are custom-mapped on this knowledge base connection?
      - Can I list field mappings for a customer's help center integration?
      instructions:
      - text: List knowledge base field mappings for token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show knowledge base mappings excluding remote metadata {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/field-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a remote knowledge base field to a target field
      effect: write
      questions:
      - How do I sync a custom article field from a knowledge base into my model?
      - Does a knowledge base mapping need a target field name and description?
      instructions:
      - text: Create knowledge base field {name} ({desc}) on {model} from {method} {url} at {path}.
        slots:
          name: requestBody.target_field_name
          desc: requestBody.target_field_description
          model: requestBody.common_model_name
          method: requestBody.remote_method
          url: requestBody.remote_url_path
          path: requestBody.remote_field_traversal_path
      - text: Map article field {path} into knowledge base target {name}, meaning {desc}, on {model} via {method} {url}.
        slots:
          path: requestBody.remote_field_traversal_path
          name: requestBody.target_field_name
          desc: requestBody.target_field_description
          model: requestBody.common_model_name
          method: requestBody.remote_method
          url: requestBody.remote_url_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/field-mappings/{field_mapping_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a knowledge base field mapping
      effect: destructive
      questions:
      - Can I remove a custom field mapping from a knowledge base integration?
      - Is mapped article data deleted along with the knowledge base mapping?
      instructions:
      - text: Delete knowledge base field mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      - text: Remove help center article mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/field-mappings/{field_mapping_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing knowledge base field mapping
      effect: write
      questions:
      - Can I change the remote method on a knowledge base field mapping?
      - How do I adjust which article field a knowledge base mapping reads?
      instructions:
      - text: Set knowledge base mapping {field_mapping_id} to remote method {remote_method}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_method: requestBody.remote_method
      - text: Repoint article mapping {field_mapping_id} at traversal path {remote_field_traversal_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/remote-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote fields from a knowledge base integration
      effect: read
      questions:
      - What raw article and container fields can I map from a knowledge base?
      - Can the knowledge base remote field list include sample values?
      instructions:
      - text: List knowledge base remote fields for {common_models}.
        slots:
          common_models: query.common_models
      - text: Show help center remote fields with example values {include_example_values}.
        slots:
          include_example_values: query.include_example_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/knowledgebase/v1/target-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide knowledge base target fields
      effect: read
      questions:
      - Which org-wide target fields exist for knowledge base articles?
      - What custom knowledge base fields have we defined across customers?
      instructions:
      - text: List knowledge base target fields for token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show our organization's knowledge base target fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/field-mappings'].get
  update:
    x-apievangelist-phrasing:
      intent: List field mappings on a ticketing linked account
      effect: read
      questions:
      - Which custom ticket fields are mapped for this customer's helpdesk?
      - Can I see the field mappings set up on a ticketing connection?
      instructions:
      - text: List ticketing field mappings for token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show helpdesk field mappings without remote metadata {exclude_remote_field_metadata}.
        slots:
          exclude_remote_field_metadata: query.exclude_remote_field_metadata
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/field-mappings'].post
  update:
    x-apievangelist-phrasing:
      intent: Map a remote ticketing field to a target field
      effect: write
      questions:
      - How do I sync a custom ticket field from a customer's helpdesk?
      - Will adding a ticketing mapping resync every ticket from the beginning?
      instructions:
      - text: Map ticket field {remote_field_traversal_path} from {remote_method} {remote_url_path} into {common_model_name}.
        slots:
          remote_field_traversal_path: requestBody.remote_field_traversal_path
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          common_model_name: requestBody.common_model_name
      - text: Create ticketing target {target_field_name} on {common_model_name} fed from {remote_method} {remote_url_path} at {remote_field_traversal_path}.
        slots:
          target_field_name: requestBody.target_field_name
          common_model_name: requestBody.common_model_name
          remote_method: requestBody.remote_method
          remote_url_path: requestBody.remote_url_path
          remote_field_traversal_path: requestBody.remote_field_traversal_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/field-mappings/{field_mapping_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ticketing field mapping
      effect: destructive
      questions:
      - Can I delete a custom ticket field mapping for one helpdesk connection?
      - Does removing a ticketing mapping delete the ticket data it synced?
      instructions:
      - text: Delete ticketing field mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
      - text: Remove helpdesk mapping {field_mapping_id} and its mapped ticket values.
        slots:
          field_mapping_id: path.field_mapping_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/field-mappings/{field_mapping_id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change an existing ticketing field mapping
      effect: write
      questions:
      - Can I edit the remote URL a ticketing field mapping pulls from?
      - Is a JMESPath change allowed on a ticket field mapping I already created?
      instructions:
      - text: Update ticketing mapping {field_mapping_id} to remote path {remote_url_path}.
        slots:
          field_mapping_id: path.field_mapping_id
          remote_url_path: requestBody.remote_url_path
      - text: Set JMES path {jmes_path} on helpdesk mapping {field_mapping_id}.
        slots:
          field_mapping_id: path.field_mapping_id
          jmes_path: requestBody.jmes_path
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/remote-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List remote fields available from a ticketing integration
      effect: read
      questions:
      - What raw ticket fields does a customer's helpdesk expose for mapping?
      - Can I get example values for remote ticketing fields?
      instructions:
      - text: List ticketing remote fields for {common_models}.
        slots:
          common_models: query.common_models
      - text: Show helpdesk remote fields with example values {include_example_values}.
        slots:
          include_example_values: query.include_example_values
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/target-fields'].get
  update:
    x-apievangelist-phrasing:
      intent: List organization-wide ticketing target fields
      effect: read
      questions:
      - Which org-wide target fields have we defined for tickets?
      - What custom ticketing fields apply across every linked helpdesk?
      instructions:
      - text: List ticketing target fields with token {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show all organization-wide ticketing target fields.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/ticketing/v1/target-fields'].post
  update:
    x-apievangelist-phrasing:
      intent: Define a new ticketing target field
      effect: write
      questions:
      - Can I add a custom ticket field that all helpdesk integrations map into?
      - What does it take to define an org-wide ticketing target field?
      instructions:
      - text: Create ticketing target field {name} on {common_model}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
      - text: Define helpdesk field {name} for {common_model}, described as {description}.
        slots:
          name: requestBody.name
          common_model: requestBody.common_model
          description: requestBody.description
      method: generated
      generated: '2026-09-26'