The API is versioned, which allows backwards-incompatible changes to be released without breaking API consumers.

There are two ways to request a particular API version:

  1. Send a Client-Version-Id header with your versioning ID
    • This is sent on every request, and is the recommended versioning method.
  2. Send an Api-Version header
    • The primary purpose is to temporarily override the Client-Version-ID and request a particular API version.
    • This is useful for debugging and testing of newer API versions. For normal requests, a Client-Version-Id header should be used.