PATCH

Overview

The HTTP PATCH component allows sending HTTP PATCH requests to external services. It is typically used to partially update resources via API calls. The connector processes the request and returns the response details, including body, headers, and status code.

Usage

Input Parameters

Parameter	Type	Description
url	string	Fully qualified URI of the target resource (required).
headers	object	JSON object containing request headers.
body	string / object	Data sent as the request body for updating the resource.
bodyBase64Encode	boolean	If enabled, encodes request body in Base64 format.
responseEncoding	string	Encoding format for the response (default: utf8). Supported values: ascii, utf8, utf16le, base64, latin1, binary, hex, null (binary mode).

Output Parameters

Parameter	Description
body	The response body from the external service.
headers	The response headers.
request	Request metadata.
statusCode	The HTTP status code of the response.

Instructions

1. Ensure API Endpoint Supports PATCH Requests

   • The url must be a valid API endpoint accepting PATCH requests.

2. Set Necessary Headers

   • If authentication is required, pass headers (e.g., Authorization token).

3. Provide Request Body

   • Use the body parameter to define the data that needs to be updated.

4. Configure Response Encoding

   • Use utf8 (default) or other supported encodings.

5. Review API Response

   • Check statusCode and body for success or failure messages.