Skip to main content
PATCH
Error

Path Parameters

id
integer<int64>
required

Body

application/json-patch+json
op
enum<string>
required
Available options:
add,
replace,
test
path
string
required
value
any
required

Response

OK

status
enum<string>
required

The coarse outcome of the request, indicating whether it succeeded or failed.

Available options:
success,
error
code
string
required

The specific machine-readable outcome code, such as ok on success or the most specific error code on failure. Always lowercase on the wire.

data
null | object
required

The response payload, either a single object for a by-id read or an array for a bulk operation. Omitted from the body when there is no value.