API Conventions

The DailyStory API enables developers to create their own custom features and integrations by providing them programmatic access to their DailyStory data and functionality.

We've created well-defined conventions to make integrations against our API an intuitive and simple experience for our users.

Standard JSON Response

With the exception of a few APIs, such as About, every API will always respond with a standard JSON format in addition to HTTP status codes to indicate success/failure.

The Status returns either true or false and is a global indicator of the success of the message. While the HTTP status code also indicates success, different status codes will be returned based on the behavior and/or error. Status provides a simple way developers can check if their API call completed successfully or failed.

The Message provides a human readable message and is typically only set when there is an error. For HTTP 4XX exceptions that occur, the Message provides a more detailed description. Such as posting a new contact and neglecting to include either a DailyStory Id, mobile number, or email address.

The Response provides one or more key/object pairs expected from the request.

For example, requesting the Campaigns GET endpoint returns a campaigns key in the response containing an array of campaign objects.