226

IM Used

2xx Success

Back to list

Server perspective

Use 226 when the response body is not the full current representation, but the result of an agreed instance manipulation such as delta encoding.

When to use

  • Return 226 only when the client explicitly negotiated a supported instance manipulation
  • Use it for specialized caching or synchronization flows, not mainstream JSON APIs

How to respond

  • Document the manipulation algorithm and negotiation rules clearly
  • Make sure validators and reconstruction rules let the client rebuild the intended current representation

Headers to consider

  • A-IM
  • If-None-Match
  • IM
  • Delta-Base
  • ETag

Response body

  • Return the manipulated or delta-encoded payload, not the plain full representation

Server-side pitfalls

  • Do not use 226 when the client does not understand the negotiated manipulation
  • Do not confuse 226 with byte ranges or application-level patch documents

Examples

Delta sync response

Request:GET /feed with A-IM: diffe
Response:226 IM Used with delta instructions and validators

The server optimizes transfer by sending a reconstruction delta instead of the full resource.

References

Related 2xx Success Codes