> 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 HTTP action

PATCH https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/{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, `null` clears it, and nested objects merge field by field. Lists of objects merge row by row instead of being replaced, so read the document first and send the whole list back when you reorder or remove rows. Lists of strings, Data Mapper expressions, JSON schemas, `workflow_steps` and `resolver_methods` are replaced 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/tool-studio/http-actions/update-http-action

## 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 HTTP action, as returned when it was created or listed.

### Body (application/json)

This endpoint expects a HttpActionConfigPatch.

- `version` (HttpActionVersionPatch, required) — Document version. On update, send back the num from your last read.
- `signature` (FunctionSignatureSettings, optional) — The action's callable contract: its name, description, input arguments and result schema. Required.
- `connector_id` (string, optional) — Connector that supplies the base URL and authentication for the request. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `method` (enum, optional) — HTTP method the action calls. One of: GET, POST, PUT, DELETE, PATCH. Required on create.
  - Allowed values: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`
- `path` (string, optional) — Path appended to the connector's base URL, not a full URL. Must start with a slash and contain no query string. Use \{\{\{variable}}} for path parameters.
- `query_params` (list of QueryParamSettings, optional) — Query parameters appended to the request URL. Up to 250.
- `headers` (list of HttpHeaderSettings, optional) — Request headers. Up to 250.
- `body_bender` (HttpActionConfigPatchBodyBender, optional) — Request body as a Moveworks data mapper expression. An update that includes this field replaces the whole body.
- `file_bender` (HttpActionConfigPatchFileBender, optional) — Files sent in the request, as a Moveworks data mapper resolving to \{argument\_name: File | File\[]}, where File is \{filename, location}. Available to body\_bender under the file keyword.

## Response

### 200

The updated HTTP action, at its new version

- `id` (string, optional) — Unique identifier of the HTTP action, assigned by the server.
- `signature` (FunctionSignatureSettings, optional) — The action's callable contract: its name, description, input arguments and result schema. Required.
- `connector_id` (string, optional) — Connector that supplies the base URL and authentication for the request. ID of an existing connector (GET /configurations/v1alpha1/platform/connectors).
- `method` (enum, optional) — HTTP method the action calls. One of: GET, POST, PUT, DELETE, PATCH. Required on create.
  - Allowed values: `GET`, `POST`, `PUT`, `DELETE`, `PATCH`
- `path` (string, optional) — Path appended to the connector's base URL, not a full URL. Must start with a slash and contain no query string. Use \{\{\{variable}}} for path parameters.
- `query_params` (list of QueryParamSettings, optional) — Query parameters appended to the request URL. Up to 250.
- `headers` (list of HttpHeaderSettings, optional) — Request headers. Up to 250.
- `body_bender` (HttpActionConfigBodyBender, optional) — Request body as a Moveworks data mapper expression. An update that includes this field replaces the whole body.
- `file_bender` (HttpActionConfigFileBender, optional) — Files sent in the request, as a Moveworks data mapper resolving to \{argument\_name: File | File\[]}, where File is \{filename, location}. Available to body\_bender under the file keyword.
- `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

### HttpActionVersionPatch

- `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.

### FunctionSignatureSettings

- `name` (string, optional) — Technical name used to reference this function. Must start with a letter and contain only letters, digits and underscores; 2 to 64 characters.
- `description` (string, optional) — Description of what this function does. 12 to 1024 characters.
- `arguments` (list of ArgumentSettings, optional) — Input arguments the function accepts.
- `result_schema` (FunctionSignatureSettingsResultSchema, optional) — JSON schema describing the function's output.
- `display_name` (string, optional) — Human-readable name of the function. 2 to 64 characters. If empty, name is shown instead.

### QueryParamSettings

- `key` (string, optional) — Name of the query parameter. Up to 8192 bytes.
- `value` (string, optional) — Value of the query parameter. Up to 8192 bytes.

### HttpHeaderSettings

- `key` (string, optional) — Name of the header, such as Content-Type. Up to 8192 bytes.
- `value` (string, optional) — Value of the header. A header with multiple values takes them as one comma-separated value.

### HttpActionConfigPatchBodyBender

Request body as a Moveworks data mapper expression. An update that includes this field replaces the whole body.

### HttpActionConfigPatchFileBender

Files sent in the request, as a Moveworks data mapper resolving to \{argument\_name: File | File\[]}, where File is \{filename, location}. Available to body\_bender under the file keyword.

### HttpActionConfigBodyBender

Request body as a Moveworks data mapper expression. An update that includes this field replaces the whole body.

### HttpActionConfigFileBender

Files sent in the request, as a Moveworks data mapper resolving to \{argument\_name: File | File\[]}, where File is \{filename, location}. Available to body\_bender under the file keyword.

### 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.

### ArgumentSettings

- `name` (string, optional) — Name of the argument. Must start with a letter and contain only letters, digits and underscores; 2 to 64 characters.
- `description` (string, optional) — Description of the argument. 2 to 256 characters.
- `type` (TypeSettings, optional) — Data type of the argument, e.g. string, List[User] or a custom type. Required.
- `required` (boolean, optional) — If true, a value must be provided for this argument.
- `default_value` (ArgumentSettingsDefaultValue, optional, nullable) — Value used for this argument when none is provided.
- `example_value` (ArgumentSettingsExampleValue, optional, nullable) — Example value for this argument.

### FunctionSignatureSettingsResultSchema

JSON schema describing the function's output.

### TypeSettings

- `primitive` (enum, optional) — A primitive type. One of: string, integer, number, boolean, array, object.
  - Allowed values: `string`, `integer`, `number`, `boolean`, `array`, `object`
- `native` (enum, optional) — A Moveworks-defined type. One of: User, File, ariba.v1.CatalogItem, workday.v1.JobProfile, Room, Group.
  - Allowed values: `User`, `File`, `ariba.v1.CatalogItem`, `workday.v1.JobProfile`, `Room`, `Group`
- `custom` (string, optional) — Name of a custom type registered in your organization. ID of an existing data_type (GET /configurations/v1alpha1/platform/extensions/data-types).
- `list` (boolean, optional) — If true, the argument is a list of the selected type rather than a single value.

### ArgumentSettingsDefaultValue

Value used for this argument when none is provided.

- string
- double
- integer
- boolean
- map from string to any
- list of any

### ArgumentSettingsExampleValue

Example value for this argument.

- string
- double
- integer
- boolean
- map from string to any
- list of any

## Examples

### HTTP Actions endpoints_updateHTTPAction_example

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "signature": {
    "name": "get_purchase_order",
    "description": "Fetch a purchase order from the ERP by its PO number.",
    "arguments": [
      {
        "name": "po_number",
        "description": "The purchase order number, e.g. PO-1024.",
        "type": {
          "primitive": "string"
        },
        "required": true,
        "example_value": "PO-1024"
      }
    ],
    "display_name": "Get Purchase Order"
  },
  "connector_id": "6f1c9f0e-6e1a-4b39-9a1e-1c6d0f2b7a55",
  "method": "GET",
  "path": "/api/v2/purchase_orders/{{{po_number}}}",
  "headers": [
    {
      "key": "Accept",
      "value": "application/json"
    }
  ],
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update the HTTP action"
  }
}
```

**SDK Code**

```python HTTP Actions endpoints_updateHTTPAction_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/id"

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

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

print(response.json())
```

```javascript HTTP Actions endpoints_updateHTTPAction_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/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 HTTP Actions endpoints_updateHTTPAction_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/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 HTTP Actions endpoints_updateHTTPAction_example
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/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 HTTP Actions endpoints_updateHTTPAction_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php HTTP Actions endpoints_updateHTTPAction_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp HTTP Actions endpoints_updateHTTPAction_example
using RestSharp;

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

```swift HTTP Actions endpoints_updateHTTPAction_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/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 a HTTP action

**Request**

```json
{
  "version": {
    "num": 2,
    "change_description": "Update the HTTP action"
  },
  "path": "/api/v2/purchase_orders/{{{po_number}}}"
}
```

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "signature": {
    "name": "get_purchase_order",
    "description": "Fetch a purchase order from the ERP by its PO number.",
    "arguments": [
      {
        "name": "po_number",
        "description": "The purchase order number, e.g. PO-1024.",
        "type": {
          "primitive": "string"
        },
        "required": true,
        "example_value": "PO-1024"
      }
    ],
    "display_name": "Get Purchase Order"
  },
  "connector_id": "6f1c9f0e-6e1a-4b39-9a1e-1c6d0f2b7a55",
  "method": "GET",
  "path": "/api/v2/purchase_orders/{{{po_number}}}",
  "headers": [
    {
      "key": "Accept",
      "value": "application/json"
    }
  ],
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 3,
    "change_description": "Update the HTTP action"
  }
}
```

**SDK Code**

```python Change a HTTP action
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/id"

payload = {
    "version": {
        "num": 2,
        "change_description": "Update the HTTP action"
    },
    "path": "/api/v2/purchase_orders/{{{po_number}}}"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Change a HTTP action
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/id';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"version":{"num":2,"change_description":"Update the HTTP action"},"path":"/api/v2/purchase_orders/{{{po_number}}}"}'
};

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

```go Change a HTTP action
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/id"

	payload := strings.NewReader("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update the HTTP action\"\n  },\n  \"path\": \"/api/v2/purchase_orders/{{{po_number}}}\"\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 a HTTP action
require 'uri'
require 'net/http'

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/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 the HTTP action\"\n  },\n  \"path\": \"/api/v2/purchase_orders/{{{po_number}}}\"\n}"

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

```java Change a HTTP action
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/id")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"version\": {\n    \"num\": 2,\n    \"change_description\": \"Update the HTTP action\"\n  },\n  \"path\": \"/api/v2/purchase_orders/{{{po_number}}}\"\n}")
  .asString();
```

```php Change a HTTP action
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/id', [
  'body' => '{
  "version": {
    "num": 2,
    "change_description": "Update the HTTP action"
  },
  "path": "/api/v2/purchase_orders/{{{po_number}}}"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Change a HTTP action
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/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 the HTTP action\"\n  },\n  \"path\": \"/api/v2/purchase_orders/{{{po_number}}}\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Change a HTTP action
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "version": [
    "num": 2,
    "change_description": "Update the HTTP action"
  ],
  "path": "/api/v2/purchase_orders/{{{po_number}}}"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-actions/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()
```