Request Format

Our API follows all standard REST API conventions. That means that as long as you're familiar with REST API patterns, you can probably guess how to filter, sort, fetch data.

The API also accepts multipart/form-data request bodies but will always respond with application/json.

It's best to use multipart/form-data request format mainly when you want to upload files (like customer photos/videos) to our servers.

In all other cases you should be using JSON.

Create Bodies

CREATE endpoints take data in a data parameter envelope like this:

{
  data: {
    rating: 5,
    heading: "Great product!",
    body: "Loved it!"
  }
}

Update Bodies

Update requests don't have an envelope and are sent with the changes in the root object like this:

{
  heading: "This is the new heading"
}