GuidesDiscussions

Error Glossary

Suggest Edits

Configuration Errors

đŸ“˜

NOTE

All requests to the Configure endpoint will return a status code of 200, including errors.

In the case of missing fields, you can expect a response like the example shown below:

{
  "error": "Missing required fields.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-configuration-errors"
}

If you receive the above error, make sure that you have included all required fields for the request.

In some cases, our server may not be able to get the expected response from your callback endpoint. The example response below is what will be returned should that happen.

{
  "error": "Improperly configured callback url.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-configuration-errors"
}

This error is only returned when our server does not receive the appropriate response from your endpoint.

Additionally, if a request is made with a different email than we have on record, the below error will be returned:

{
  "error": "Invalid email",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-configuration-errors"
}

All callback URLs require the inclusion of the http:// or https:// protocol schema at the beginning of the string. Leaving it out will result in the error response below.

{
  "error": "Callback url missing schema. Please make sure your callback url includes http:// or https://",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-configuration-errors"
}

If your callback URL is using HTTPS, sometimes our server struggles to make a connection due to the SSL configuration. In those rare cases, the error below will be returned:

{
  "error": "SSL Error. We were unable to be verified by your server.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-configuration-errors"
}

General Errors

If a request is made on a resource using an ID that is not related, the following error will be returned:

{
  "error": "The resource you are trying to access could not be found.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-general-errors"
}

If a request is made with required POST data missing, you will receive the following error response:

{
  "error": "Bad Request. Some or all required fields are missing.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-general-errors"
}

Expired Token

If a request is made with an expired token, an HTTP 401 will be returned with the following information:

{
  "details": "Authentication credentials were not provided."
}

If you receive this error, make a new GET request to the Authentication resource.

Login Errors

If a request for an access token is made with a client ID and key that do not match, the following error will be returned:

{
  "error": "Unauthorized",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-login-errors"
}

Data Conflict Errors

Occasionally there is data that is commonly overwritten by mistake. To prevent this from happening we return the following error on POST requests where this would affect a large portion of the data rather than simply accepting the request. If you want to overwrite the data anyway, you should use a PUT request instead.

{
  "error": "The resource you are trying to create already exists.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-data-conflict-errors"
}

Profile Update Errors

There are a few errors that can occur when attempting to update a profile. An example of each is provided in the following table.

{
  "error": "Data Source Not Supported.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-profile-update-errors"
}

{
  "error": "That data source does not match for the url provided.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-profile-update-errors"
}

{
  "error": "Failed to change the url.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-profile-update-errors"
}

Suggested Action Errors

If a request to edit a suggested response is made without an updated value for the content, the following error response will be returned.

{
  "error": "Bad Request. An edit requires the content to change.",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-suggested-action-errors"
}

Update/Callback Errors

If you try to remove the last callback_url

{
  "error": "Callback url minimum reached",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-updatecallback-errors"
}

If you try to add more than 3 callback_url

{
  "error": "Callback url limit reached",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-updatecallback-errors"
}

If you try to update a URL that does not exist in our database

{
  "error": "Callback url not found",
  "reference": "https://reply-pro.readme.io/v1.0/docs/error-glossary#section-updatecallback-errors"
}

HTTP 415 error - "Unsupported media type"

Our API only handles JSON media types. Make sure in your header you set the Content-Type to be "application/json"

Updated over 5 years ago