---
title: "httpPatch"
canonical: "https://support.appfire.com/space/PSJC/434930150/httpPatch"
format: markdown
---
> Macro (aura-html)


## Description

> Macro (excerpt)
> 
> Executes an HTTP PATCH for the given URL using the specified HttpRequest object.

Executes an HTTP PATCH for the given URL using the specified HttpRequest object. The data used for the PATCH can be either included in the request object (as name-value parameters) or it can be added as a separate parameter (in the case of JSON, struct and so on). Requests can also be sent through a proxy.

|  |  |  |  |
| --- | --- | --- | --- |
| **Syntax** | httpPatch(url, request [[, proxy] [, patchDataObject]]) | **Package** | http |
| **Alias** |  | **Pkg Usage** | patch(url, request [[, proxy] [, patchDataObject]]) |

## Parameters

| Parameter name | Type | Required | Description |
| --- | --- | --- | --- |
| url | String | Yes | The URL |
| request | HttpRequest | Yes | An HttpRequest object containing headers, cookies, parameters |
| proxy | HttpProxy | No | An HttpProxy object containing the host and port of the proxy server. |
| patchDataObject | variable: string, array or struct | No | Data to be used for the PATCH method |

## Return Type

**String**

Variable return type depends on the left hand side operator type.

> ⚠️ The request parameter should have the HttpRequest type described [here](https://appfire.atlassian.net/wiki/spaces/PSJC/pages/435028065). The HttpProxy type is described [here](https://appfire.atlassian.net/wiki/spaces/PSJC/pages/435028065).

## See also

> Macro (contentbylabel)