From RPTools Wiki
Jump to navigation Jump to search

REST.patch() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.5.0
Perform an HTTP patch request, to the specified URL, to make a partial update to the specified resource.


REST.patch(url, payload, mediaType, getFullResponse)
REST.patch(url, payload, mediaType, headers, getFullResponse)


  • url - String containing the URL to the resource or collection of resources.
  • payload - JSON object containing the key:value pairs.
  • mediaType - String containing a MIME type and charset. See example.
  • headers - JSON object containing header key:value pairs.
  • getFullResponse - Boolean (0:1). Use true(1) to get full response.


HTTP response as JSON (if full response) or server response, usually JSON but can be XML, HTML, or other formats.


Update user data with contents of payload.
[h: baseURL = ""]
[h: path = "/api/users/2"]
[h: mediaType = "application/json; charset=utf-8"]
[h: getFullResponse = 1]

[h: payload = '{ "name": "morpheus", "job": "zion resident" }']

[h: response = REST.patch(baseURL + path, payload, mediaType, getFullResponse)]

[r: json.indent(response, 2)]


  "status": 200,
  "headers":   {
    "access-control-allow-origin": ["*"],
    "cf-ray": ["4b927aa4ea915414-LAX"],
    "content-type": ["application/json; charset=utf-8"],
    "date": ["Sun, 17 Mar 2019 22:42:16 GMT"],
    "etag": ["W/\"50-xvMYBAeY4FNOMM/22NyIcimiIYc\""],
    "expect-ct": ["max-age=604800, report-uri=\"\""],
    "server": ["cloudflare"],
    "set-cookie": ["__cfduid=d97966d3e9434720192d81096687475ff1552862536; expires=Mon, 16-Mar-20 22:42:16 GMT; path=/;; HttpOnly"],
    "x-powered-by": ["Express"]
  "body":   {
    "name": "morpheus",
    "job": "zion resident",
    "updatedAt": "2019-03-17T22:46:47.729Z"

See Also