DO Ideas 2

Flesh-out the API documentation

Would love the the API documentation to be fleshed out.

IMHO Mailgun provides an example of good documentation.

I think what's key is a Quickstart Guide: Here are likely scenarios, here's example code for those scenarios, here's responses you'll get in those scenarios.

  • Kerry Ivan Kurian
  • Sep 11 2018
  • Shipped
  • Sep 11, 2018

    Admin Response

    We've shipped the new version of the API. It is now available for all customers as a beta release under the API section and documentation can be found at: We've done a lot of work to update the documentation and make it easier to read and get started. We've also added a change log that is hosted publicly on github where we are collecting issues, comments, bug reports, and feedback from customers. Thanks!
  • Attach files
  • Moisey Uretsky commented
    September 11, 2018 19:41

    Thanks for the feedback Ivan, we will be adding more error message consistency to the API and then documenting.

    In the future we will be moving to a fully restful API so you will be able to get that information easier from the HTTP headers in regards to whether a call succeeded or failed.