Transitioning Custom Rules to Updated API Versions

Diffbot’s Custom API Toolkit allows you to override default Diffbot API fields (and add new fields, and create new APIs entirely).

As Diffbot’s API fields and structure have changed (see this guide to migrating to newer versions of our APIs), so too has the structure behind our API Toolkit.

To ensure your API overrides continue to work as you transition to newer versions of our APIs, follow this quick guide:

Product API

If you have created rules against the V2 API, you will need to migrate your previous rules when you transition to V3. Either delete and recreate your rules, or contact Diffbot Support for help migrating.

Article API

Article API fields have largely stayed the same between V1 and V3, with media elements being the primary exception. (In V1 images and videos were returned within the media element; in V2 and V3 these were returned in separate images and videos arrays.) If you have media rules from V1 of the Article API, you will need to delete and recreate your rule, or contact Diffbot Support for help migrating.