// HTTP method
PATCH
Apply a partial modification to the target resource rather than replacing its complete representation.
UnsafeNot guaranteed to be idempotent. It depends on the patch document and server semantics; setting a value can be idempotent while incrementing one is not.
Idempotency
Not guaranteed to be idempotent. It depends on the patch document and server semantics; setting a value can be idempotent while incrementing one is not.
Common use cases
- Update selected fields.
- Apply a JSON Patch document.
- Change one state property without sending the full resource.
Common mistakes
- Leaving null versus omitted behavior undefined.
- Assuming every patch can be retried safely.
- Accepting unknown fields silently.
Request
PATCH /profiles/usr_123 HTTP/1.1
Content-Type: application/merge-patch+json
{ "timezone": "Europe/Prague" }Response
HTTP/1.1 200 OK
Content-Type: application/json
{ "id": "usr_123", "timezone": "Europe/Prague" }// GET STARTED
Design and test a PATCH operation.
Define the contract in API Designer, then execute it with Cloud Runner or Browser Runner.