api patch
HTTP PATCH with optional body, body file, or multipart form queue
Syntax
When I api patch "<path>"
When I api patch "<path>" with body '<json-or-text>'
When I api patch "<path>" with body file "<filename>"Requirements
| Item | Contract |
|---|---|
| Element / control shape | None — HTTP session (Platform: api) |
| How the label binds | Path / body / headers are payloads ($ENV, slots expand) |
| Qualifiers that change resolve | See this command’s Qualifiers table |
| Platform | Platform: api only — requires $API_BASE_URL (and auth env as needed) |
| Wrong shape → use instead | UI XHR wait → wait for response. Browser UI → web commands |
See also UI contracts and Platform: api.
Examples
When I api patch "/orders/ord-1" with body '{"item":"pencil"}'
Then I api should status "200"Bare api patch with a pending form queue sends multipart (same as api post).