API errors and their description
As with any web service, our API will return
5xxlevel errors when appropriate. Always check the status code to ensure the request was successfully received and successfully handled.
4xxlevel error code indicates that something is wrong with the request. Our recommendation is to double check the request for any typos.
2xxlevel responses will contain a
statusproperty. This property will indicate whether the requested operation was successfully completed or if an error was encountered.
When an error does occur a
messageproperty will be included with a detailed message about why it failed. These error messages will be returned with a 200 level status code.
Example Error Response
"message":"Missing required parameter 'email'",