Responses to a PATCH
Every successful PATCH generates a response object with a response payload. Depending on the default fields returned and whether any query parameters have been specified, the response payload may or may not contain the values modified by the PATCH.
Similarly to request schemas, response schemas follow certain patterns around using data envelopes to wrap the resource schema. In many instances, the request and response schemas will match.
Fields with null values are omitted
Similar to GETs and POSTs, the response payloads for PATCHes contain only fields whose values are non-null. Fields with null values are omitted from the response payload.
If a given field is expected in a response payload but it is missing, this is often because the value was null.
PATCHes and query parameters
You can use the
fields query parameter with a PATCH to control the fields
that appear in the response payload. For example, the following PATCHes a note for activity
xc:20 based on the request payload. The response payload has the default fields.
The following also PATCHes a note for activity xc:20 based on the request payload. But, the
response payload includes only the