Better Proposals API always return a JSON as response body.
It always include a status key, which can have two values:
success or error
With that you can simply know your request has succeeded or not.
If status is "success" then it always have a key called data, where your requested information is stored.
This error means that request you sent to the server is not correctly formed. Mostly this kind of error appears when you don't pass access token to request headers
{ "status": "error", "message": "Malformed request" }
This error appears when the token you passed is not valid anymore. View API Authentication details
{ "status": "error", "message": "Invalid token" }
This error appears when endpoint url is not found or is not available in the current version of the API.
You can view available api endpoints in the API documentation menu.
{ "status": "error", "message": "Not found" }
Status code | Description |
---|---|
2XX | Success |
4XX | Client error |
5XX | Server error |
We currently support only header authorization type.
Simply include Bptoken: YOUR_API_TOKEN in your request headers.
{ "status": "success", "data": {}, // This object depends on created proposal's details. }
{ "status": "success", "data": {}, // This object depends on created cover's details. }
{ "status": "success", "data": {}, // This object depends on created quote's details. }
{ "status": "success", "data": {}, // This object depends on created company's details. }