Change Updates

Do not miss any Storydoc API changes, ever again

Subscribe to the Storydoc API changelog to be up to date on recent changes.

RSS

Changelog

Last update:
Compare
2 structure changes including:
2 Modifications
Modified 2
POST /v2/versions
  • Body
  • application/json content type Modified
    • data property Modified
      • ogImage property Added
POST /v2/versions/{versionId}
  • Body
  • application/json content type Modified
    • data property Modified
      • ogImage property Added
2 structure changes including:
1 Breaking change
1 Addition
1 Modification
Modified 1 Breaking
POST /v2/versions
  • Path went from /versions to /v2/versions (same operationId)
    Breaking
  • Body
  • application/json content type Modified
    • Content type is now required
      Breaking
    • daysToExpire property Modified
      • Type went from number(integer) to integer
        Breaking
    • data property Modified
      • link1, link2, free_text1, free_text2, title1, title2, number1, number2, number3, number4, number5, number6 properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • products, gatedContent, password, logo properties Added
    • storyId property Added
  • Response
  • 200 response Modified
    • application/json content type Modified
      • versionId property Added
  • 400 response Modified
    • application/json content type Added
  • 403 response Modified
    • application/json content type Added
  • 429 response Modified
    • application/json content type Added
  • 500 response Modified
    • application/json content type Modified
      • code, message properties Removed
        • Removing a resource is always breaking unless it was deprecated before
          Breaking
      • error property Added
Added 1
POST /v2/versions/{versionId}
1 structure change including:
1 Modification
Modified 1 Breaking
POST /versions
  • Body
  • content type Modified
    • senderEmail property Modified