PUT

Overview

The HTTP PUT Component sends HTTP PUT requests to external services. It is commonly used for updating or replacing resources via API calls.

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.

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.

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 PUT Requests

    • The url must be a valid API endpoint accepting PUT 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 being sent.

  4. Configure Response Encoding

    • Use utf8 (default) or other supported encodings.

  5. Review API Response

    • Check statusCode and body for success or failure messages.

Notes

  • PUT requests typically replace entire resources: Ensure that the provided data includes all necessary fields.

  • Proper headers must be set: Use Content-Type: application/json for JSON payloads.

Last updated