> This page is for API Reference & Tools.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.moveworks.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.moveworks.com/_mcp/server.

# Update form

PATCH https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/{id}
Content-Type: application/json

Changes the fields you send and returns the full updated document.

Send only the fields you want to change, plus `version` with the `num` from your last read and a `change_description`. This is a JSON merge-patch: a field you leave out keeps its stored value, and every list or map you send replaces the stored one whole. The `id` goes in the URL; if you also send `id` in the body it must match.

Reference: https://docs.moveworks.com/api-reference/configuration-api/content-forms/forms/update-form

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Request

### Path parameters

- `id` (string, required) — The `id` of the form, as returned when it was created or listed.

### Body (application/json)

This endpoint expects a FormsConfigPatch.

- `version` (FormVersionPatch, required) — Document version. On update, send back the num from your last read.
- `name` (string, optional) — Name of this forms ingestion, for your reference.
- `service_now_config` (SNOWConfigPatch, optional) — Form ingestion settings for ServiceNow.
- `jira_config` (FormJiraConfigPatch, optional) — Form ingestion settings for Jira Service Management.
- `fresh_service_config` (FormFreshServiceConfigPatch, optional) — Form ingestion settings for Freshservice.
- `wolken_config` (FormWolkenConfigPatch, optional) — Form ingestion settings for Wolken.
- `ivanti_config` (FormIvantiConfigPatch, optional) — Form ingestion settings for Ivanti.
- `solarwinds_config` (FormSolarwindsConfigPatch, optional) — Form ingestion settings for SolarWinds.
- `bmc_remedy_config` (BMCRemedyConfigPatch, optional) — Form ingestion settings for BMC Remedy.
- `bmc_remedy_dwp_config` (BMCRemedyDwpConfigPatch, optional) — Form ingestion settings for BMC Remedy Digital Workplace.
- `manage_engine_config` (FormManageEngineConfigPatch, optional) — Form ingestion settings for ManageEngine.
- `workday_config` (FormWorkdayConfigPatch, optional) — Form ingestion settings for Workday.
- `microsoft_dynamics_config` (FormMicrosoftDynamicsConfig, optional) — Form ingestion settings for Microsoft Dynamics.
- `symphony_config` (FormSymphonyConfigPatch, optional) — Form ingestion settings for Symphony.
- `gateway_config` (GatewayConfig, optional) — Form ingestion settings for Gateway.

## Response

### 200

The updated form, at its new version

- `id` (string, optional) — Unique identifier of the forms ingestion configuration, assigned by the server. Cannot be changed.
- `name` (string, optional) — Name of this forms ingestion, for your reference.
- `connector_id` (string, optional) — ID of the connector that forms are ingested from. Cannot be changed after creation. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `system` (enum, optional) — External system the forms are ingested from. Must match the system-specific settings provided. Cannot be changed after creation.
  - Allowed values: `EXTERNAL_SYSTEM_SERVICE_NOW`, `EXTERNAL_SYSTEM_JIRA`, `EXTERNAL_SYSTEM_BMC_REMEDY`, `EXTERNAL_SYSTEM_BMC_REMEDY_DWP`, `EXTERNAL_SYSTEM_FRESH_SERVICE`, `EXTERNAL_SYSTEM_IVANTI`, `EXTERNAL_SYSTEM_MANAGE_ENGINE`, `EXTERNAL_SYSTEM_MICROSOFT_DYNAMICS`, `EXTERNAL_SYSTEM_SOLARWINDS`, `EXTERNAL_SYSTEM_SYMPHONY`, `EXTERNAL_SYSTEM_WOLKEN`, `EXTERNAL_SYSTEM_WORKDAY`, `EXTERNAL_SYSTEM_GATEWAY`
- `service_now_config` (SNOWConfig, optional) — Form ingestion settings for ServiceNow.
- `jira_config` (FormJiraConfig, optional) — Form ingestion settings for Jira Service Management.
- `fresh_service_config` (FormFreshServiceConfig, optional) — Form ingestion settings for Freshservice.
- `wolken_config` (FormWolkenConfig, optional) — Form ingestion settings for Wolken.
- `ivanti_config` (FormIvantiConfig, optional) — Form ingestion settings for Ivanti.
- `solarwinds_config` (FormSolarwindsConfig, optional) — Form ingestion settings for SolarWinds.
- `bmc_remedy_config` (BMCRemedyConfig, optional) — Form ingestion settings for BMC Remedy.
- `bmc_remedy_dwp_config` (BMCRemedyDwpConfig, optional) — Form ingestion settings for BMC Remedy Digital Workplace.
- `manage_engine_config` (FormManageEngineConfig, optional) — Form ingestion settings for ManageEngine.
- `workday_config` (FormWorkdayConfig, optional) — Form ingestion settings for Workday.
- `microsoft_dynamics_config` (FormMicrosoftDynamicsConfig, optional) — Form ingestion settings for Microsoft Dynamics.
- `symphony_config` (FormSymphonyConfig, optional) — Form ingestion settings for Symphony.
- `gateway_config` (GatewayConfig, optional) — Form ingestion settings for Gateway.
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.

## Errors

### 400 Bad Request Error

Bad request - the body breaks a rule in the schema (a missing required field, an unknown enum value, an invalid DSL or Data Mapper expression), `version.change_description` is missing, or an id in the body doesn't match the URL

- `error` (ErrorResponseError, required)

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 404 Not Found Error

Not found - no item with this `id` exists in your organization

- `error` (ErrorResponseError, required)

### 409 Conflict Error

Conflict - `version.num` doesn't match the stored version (someone changed it since your last read; read it again and retry), or the item already exists

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### FormVersionPatch

- `num` (integer, required) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, required) — A short note describing this change. Required on every create and update.

### SNOWConfigPatch

- `domain_configs` (list of SNOWPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `requester_field_names` (list of string, optional) — Form field names to pre-populate with the current user, typically 'requested_for' and 'requested_by'.
- `script_ids_to_ignore` (list of string, optional) — sys_ids of client scripts that can safely be ignored. Ignoring them lets more forms be filled natively in chat.
- `custom_url_field` (string, optional) — Name of an attribute in your instance that holds the full form URL. If set, its value is used as the form URL instead of the URL template.
- `access_lite_ingestion` (boolean, optional) — If true, all forms redirect users to fill them in the ServiceNow portal instead of in the AI Assistant.

### FormJiraConfigPatch

- `domain_configs` (list of JiraPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.

### FormFreshServiceConfigPatch

- `domain_configs` (list of FreshServicePerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### FormWolkenConfigPatch

- `domain_configs` (list of WolkenPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### FormIvantiConfigPatch

- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `domain_configs` (list of IvantiPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### FormSolarwindsConfigPatch

- `domain_configs` (list of SolarwindsPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### BMCRemedyConfigPatch

- `domain_configs` (list of BMCRemedyPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.

### BMCRemedyDwpConfigPatch

- `domain_configs` (list of BMCRemedyDwpPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.

### FormManageEngineConfigPatch

- `domain_configs` (list of ManageEnginePerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `map_subject_to_form_title` (boolean, optional) — If true, the ManageEngine 'subject' field is used as the form title. Confirm the 'subject' field is available in your instance first.

### FormWorkdayConfigPatch

- `domain_configs` (list of WorkdayPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `report_name` (string, optional) — Name of the Workday report that lists all case types (forms).
- `url_template` (string, optional) — End-user facing URL that redirects users to the Workday Help Center form, such as Create Case. Varies by tenant. If blank, redirect links are not shown.
- `include_non_fillable_forms` (boolean, optional) — If true, non-fillable forms are also ingested and shown with their redirect URL. If false, only fillable forms are ingested.

### FormMicrosoftDynamicsConfig

- `url_template` (string, optional) — End-user facing URL template used to link users to a form, using the form's \{adx\_partialurl} as the placeholder. If blank, a default URL format is used.
- `domain_config` (MicrosoftDynamicsPerDomainConfig, optional) — Form ingestion settings for Microsoft Dynamics, including the business domain and filters.

### FormSymphonyConfigPatch

- `domain_configs` (list of SymphonyPerDomainConfigPatch, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### GatewayConfig

- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.

### SNOWConfig

- `domain_configs` (list of SNOWPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `requester_field_names` (list of string, optional) — Form field names to pre-populate with the current user, typically 'requested_for' and 'requested_by'.
- `script_ids_to_ignore` (list of string, optional) — sys_ids of client scripts that can safely be ignored. Ignoring them lets more forms be filled natively in chat.
- `custom_url_field` (string, optional) — Name of an attribute in your instance that holds the full form URL. If set, its value is used as the form URL instead of the URL template.
- `access_lite_ingestion` (boolean, optional) — If true, all forms redirect users to fill them in the ServiceNow portal instead of in the AI Assistant.

### FormJiraConfig

- `domain_configs` (list of JiraPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.

### FormFreshServiceConfig

- `domain_configs` (list of FreshServicePerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### FormWolkenConfig

- `domain_configs` (list of WolkenPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### FormIvantiConfig

- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `domain_configs` (list of IvantiPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### FormSolarwindsConfig

- `domain_configs` (list of SolarwindsPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### BMCRemedyConfig

- `domain_configs` (list of BMCRemedyPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.

### BMCRemedyDwpConfig

- `domain_configs` (list of BMCRemedyDwpPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.

### FormManageEngineConfig

- `domain_configs` (list of ManageEnginePerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `map_subject_to_form_title` (boolean, optional) — If true, the ManageEngine 'subject' field is used as the form title. Confirm the 'subject' field is available in your instance first.

### FormWorkdayConfig

- `domain_configs` (list of WorkdayPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.
- `report_name` (string, optional) — Name of the Workday report that lists all case types (forms).
- `url_template` (string, optional) — End-user facing URL that redirects users to the Workday Help Center form, such as Create Case. Varies by tenant. If blank, redirect links are not shown.
- `include_non_fillable_forms` (boolean, optional) — If true, non-fillable forms are also ingested and shown with their redirect URL. If false, only fillable forms are ingested.

### FormSymphonyConfig

- `domain_configs` (list of SymphonyPerDomainConfig, optional) — Form ingestion settings grouped by business domain. Between 1 and 50 entries.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

### SNOWPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `default_filter` (DefaultSNOWFilterPatch, optional) — Use the default filtering, which mirrors the forms visible in the ServiceNow service portal.
- `advanced_filter` (AdvancedSNOWFilter, optional) — Use your own query filter to define which forms are ingested.
- `whitelisted_ids` (list of string, optional) — Additional form sys_ids to ingest that are not matched by the filter.
- `url_template` (string, optional) — End-user facing URL template for forms, with \{form\_id} as the placeholder. If blank, the default https\://\<instance>.service-now\.com/sp?id=sc\_cat\_item\&sys\_id=\{form\_id} format is used.
- `order_guide_url_template` (string, optional) — End-user facing URL template for order guides, with \{form\_id} as the placeholder. If blank, the default https\://\<instance>.service-now\.com/sp?id=sc\_cat\_item\_guide\&sys\_id=\{form\_id} format is used.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### JiraPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_catalog_ids` (list of string, optional) — Service desk IDs whose forms are all ingested.
- `ids_to_keep` (list of string, optional) — Additional form IDs to ingest that do not belong to the listed service desks.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### FreshServicePerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_category_ids` (list of string, optional) — Category IDs of the forms to ingest. If empty, all categories in the workspace are ingested.
- `ids_to_keep` (list of string, optional) — Additional form IDs to ingest that do not belong to the listed categories.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `workspace_id` (string, optional) — ID of the Freshservice workspace to ingest forms from.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### WolkenPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_catalog_ids` (list of string, optional) — Catalog IDs to ingest forms from.
- `ids_to_keep` (list of string, optional) — Additional form IDs to ingest.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### IvantiPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Query that filters which forms to ingest, e.g. Status eq 'Published (Automatic)'.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### SolarwindsPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_category_ids` (list of string, optional) — Category IDs of the forms to ingest.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### BMCRemedyPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Filter conditions for which forms to ingest, sent as the 'q' query parameter of the forms API request, e.g. (OperationID='ID1') OR (OperationID='ID2').
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### BMCRemedyDwpPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Filter conditions for which forms to ingest, sent as a JSON string in the body of the forms API request, e.g. \{'serviceIds': \['501']}.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### ManageEnginePerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Filter conditions, as a JSON string sent in the 'input_data' query parameter, that limit which forms are ingested. If empty, a default filter for active service templates is used.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### WorkdayPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### MicrosoftDynamicsPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `filter_query` (string, optional) — Filter conditions, as a JSON string sent in the query parameters of the forms API request, e.g. \{'active': 'true'}.

### SymphonyPerDomainConfigPatch

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `table_ids` (list of string, optional) — IDs of the tables to ingest forms from. At least one is required.
- `tenant` (string, optional) — Identifier of the tenant whose forms are fetched. Required; sent as a URL parameter.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### SNOWPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `default_filter` (DefaultSNOWFilter, optional) — Use the default filtering, which mirrors the forms visible in the ServiceNow service portal.
- `advanced_filter` (AdvancedSNOWFilter, optional) — Use your own query filter to define which forms are ingested.
- `whitelisted_ids` (list of string, optional) — Additional form sys_ids to ingest that are not matched by the filter.
- `url_template` (string, optional) — End-user facing URL template for forms, with \{form\_id} as the placeholder. If blank, the default https\://\<instance>.service-now\.com/sp?id=sc\_cat\_item\&sys\_id=\{form\_id} format is used.
- `order_guide_url_template` (string, optional) — End-user facing URL template for order guides, with \{form\_id} as the placeholder. If blank, the default https\://\<instance>.service-now\.com/sp?id=sc\_cat\_item\_guide\&sys\_id=\{form\_id} format is used.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### JiraPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_catalog_ids` (list of string, optional) — Service desk IDs whose forms are all ingested.
- `ids_to_keep` (list of string, optional) — Additional form IDs to ingest that do not belong to the listed service desks.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### FreshServicePerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_category_ids` (list of string, optional) — Category IDs of the forms to ingest. If empty, all categories in the workspace are ingested.
- `ids_to_keep` (list of string, optional) — Additional form IDs to ingest that do not belong to the listed categories.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `workspace_id` (string, optional) — ID of the Freshservice workspace to ingest forms from.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### WolkenPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_catalog_ids` (list of string, optional) — Catalog IDs to ingest forms from.
- `ids_to_keep` (list of string, optional) — Additional form IDs to ingest.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### IvantiPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Query that filters which forms to ingest, e.g. Status eq 'Published (Automatic)'.
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion. Respected regardless of other settings.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### SolarwindsPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `whitelisted_category_ids` (list of string, optional) — Category IDs of the forms to ingest.
- `url_template` (string, optional) — End-user facing URL template used to link users to a form in the source system, with \{form\_id} as the form placeholder. If blank, a default URL format is used.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### BMCRemedyPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Filter conditions for which forms to ingest, sent as the 'q' query parameter of the forms API request, e.g. (OperationID='ID1') OR (OperationID='ID2').
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### BMCRemedyDwpPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Filter conditions for which forms to ingest, sent as a JSON string in the body of the forms API request, e.g. \{'serviceIds': \['501']}.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### ManageEnginePerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `filter_query` (string, optional) — Filter conditions, as a JSON string sent in the 'input_data' query parameter, that limit which forms are ingested. If empty, a default filter for active service templates is used.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### WorkdayPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `disallowed_ids` (list of string, optional) — Form IDs to exclude from ingestion.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### SymphonyPerDomainConfig

- `domain` (enum, optional) — Business domain of the forms in this group, such as IT or HR. Helps serve users relevant forms.
  - Allowed values: `IT_DOMAIN`, `HR_DOMAIN`, `FACILITY_DOMAIN`, `FINANCE_DOMAIN`, `LEGAL_DOMAIN`, `PAYROLL_DOMAIN`, `PROCUREMENT_DOMAIN`, `TRAVEL_AND_EXPENSE_DOMAIN`, `SALES_DOMAIN`, `HEALTHCARE_DOMAIN`, `LOGISTICS_DOMAIN`, `OTHER_DOMAIN`
- `table_ids` (list of string, optional) — IDs of the tables to ingest forms from. At least one is required.
- `tenant` (string, optional) — Identifier of the tenant whose forms are fetched. Required; sent as a URL parameter.
- `item_ref` (string, optional) — Identifier the server assigns to this entry. Leave it unset when adding an entry; send back the value from your last read when updating.

### DefaultSNOWFilterPatch

- `catalog_ids` (list of string, optional) — sys_ids of the service catalogs to ingest forms from. At least one is required.
- `ingest_forms_missing_catalog_api_access` (boolean, optional) — If true, forms that cannot be read through the catalog API are still ingested, even though not all filtering logic can be applied to them.
- `extra_sys_class_names_to_ingest` (list of string, optional) — Additional table names to ingest forms from, on top of the default catalog item tables. Each table must extend sc_cat_item. Up to 100.

### AdvancedSNOWFilter

- `sc_cat_item_sysparm_query_filter` (string, optional) — Encoded query on the sc_cat_item table selecting the forms to ingest, e.g. active=true^categoryISNOTEMPTY.

### DefaultSNOWFilter

- `catalog_ids` (list of string, optional) — sys_ids of the service catalogs to ingest forms from. At least one is required.
- `ingest_forms_missing_catalog_api_access` (boolean, optional) — If true, forms that cannot be read through the catalog API are still ingested, even though not all filtering logic can be applied to them.
- `extra_sys_class_names_to_ingest` (list of string, optional) — Additional table names to ingest forms from, on top of the default catalog item tables. Each table must extend sc_cat_item. Up to 100.

## Examples

### Forms endpoints_updateForm_example

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "name": "example-name",
  "connector_id": "<connector-uuid>",
  "system": "EXTERNAL_SYSTEM_SERVICE_NOW",
  "service_now_config": {
    "domain_configs": [
      {
        "domain": "IT_DOMAIN",
        "default_filter": {
          "catalog_ids": [
            "<id>"
          ],
          "ingest_forms_missing_catalog_api_access": true,
          "extra_sys_class_names_to_ingest": [
            "example-name"
          ]
        },
        "whitelisted_ids": [
          "<id>"
        ],
        "url_template": "https://example.com/path",
        "order_guide_url_template": "https://example.com/path",
        "disallowed_ids": [
          "<id>"
        ],
        "item_ref": "<string>"
      }
    ],
    "requester_field_names": [
      "example-name"
    ],
    "script_ids_to_ignore": [
      "<id>"
    ],
    "custom_url_field": "https://example.com/path",
    "access_lite_ingestion": true
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update via the Configuration API"
  }
}
```

**SDK Code**

```python Forms endpoints_updateForm_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id"

headers = {"Authorization": "Bearer <token>"}

response = requests.patch(url, headers=headers)

print(response.json())
```

```javascript Forms endpoints_updateForm_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id';
const options = {method: 'PATCH', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Forms endpoints_updateForm_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id"

	req, _ := http.NewRequest("PATCH", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Forms endpoints_updateForm_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Forms endpoints_updateForm_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Forms endpoints_updateForm_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Forms endpoints_updateForm_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Forms endpoints_updateForm_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Change one field of a form

**Request**

```json
{
  "version": {
    "num": 2,
    "change_description": "Update via the Configuration API"
  },
  "name": "example-name"
}
```

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "name": "example-name",
  "connector_id": "<connector-uuid>",
  "system": "EXTERNAL_SYSTEM_SERVICE_NOW",
  "service_now_config": {
    "domain_configs": [
      {
        "domain": "IT_DOMAIN",
        "default_filter": {
          "catalog_ids": [
            "<id>"
          ],
          "ingest_forms_missing_catalog_api_access": true,
          "extra_sys_class_names_to_ingest": [
            "example-name"
          ]
        },
        "whitelisted_ids": [
          "<id>"
        ],
        "url_template": "https://example.com/path",
        "order_guide_url_template": "https://example.com/path",
        "disallowed_ids": [
          "<id>"
        ],
        "item_ref": "<string>"
      }
    ],
    "requester_field_names": [
      "example-name"
    ],
    "script_ids_to_ignore": [
      "<id>"
    ],
    "custom_url_field": "https://example.com/path",
    "access_lite_ingestion": true
  },
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update via the Configuration API"
  }
}
```

**SDK Code**

```python Change one field of a form
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id"

payload = {
    "version": {
        "num": 2,
        "change_description": "Update via the Configuration API"
    },
    "name": "example-name"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript Change one field of a form
const url = 'https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"num":2,"change_description":"Update via the Configuration API"},"name":"example-name"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Change one field of a form
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id"

	payload := strings.NewReader("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  },\n  \"name\": \"example-name\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Change one field of a form
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  },\n  \"name\": \"example-name\"\n}"

response = http.request(request)
puts response.read_body
```

```java Change one field of a form
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  },\n  \"name\": \"example-name\"\n}")
  .asString();
```

```php Change one field of a form
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id', [
  'body' => '{
  "version": {
    "num": 2,
    "change_description": "Update via the Configuration API"
  },
  "name": "example-name"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Change one field of a form
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update via the Configuration API\"\n  },\n  \"name\": \"example-name\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change one field of a form
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "version": [
    "num": 2,
    "change_description": "Update via the Configuration API"
  ],
  "name": "example-name"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/tool/search/forms/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```