> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/utils/http/put.md).

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


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/utils/http/put.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.