For the complete documentation index, see llms.txt. This page is also available as Markdown.

PATCH

Perform a API PATCH request and store the returned value.

PATCH sends a partial update to an HTTP endpoint and stores the response. Use it to change one or more fields on an existing resource without replacing the full record.

For a walkthrough of auth Headers, storage names, and JSON asserts, see Test APIs in a Flow.

PATCH Test Step

When to use it

  • Update a single field on a record the UI created earlier.

  • Apply a status change through an API before the browser Flow verifies the new state.

  • Assert the response with Check JSON Value using the same storage name.

Configure

Basics

Field
What to set

URL

Fully qualified URL, or a Value that expands to one

Body Content-Type

No Body, JSON (application/json) (default), JSON:API (application/vnd.api+json), XML (application/xml), XML (text/xml), Plain Text (text/plain), URL Encoded (x-www-form-urlencoded), or Form Data (multipart/form-data)

Body (conditional)

Request body (editor matches Content-Type)

Response Storage Name

Name for the stored response (response by default)

Advanced

Field
What to set

Headers

Request headers as JSON

Expected Response Status Codes

Defaults to 2xx. Choose 200 or other codes when the API requires them

Response Object

Body (default), Headers, or Complete

Status on fail

Pro tip: Switch Method on the step to move between GET, POST, PUT, PATCH, and DELETE without rebuilding the rest of the configuration.

Tags: integration, api, patch, rest

Last updated