Error codes

The Prebuilt Recommendation API attempts to return appropriate HTTP status codes for every request.

200OKThe request was successful.
201CreatedThe request was fulfilled and resulted in a new resource being created.
202AcceptedThe request was accepted for processing, but the processing was not completed.
204No ContentThe server successfully processed the request, and is not returning any content.
400Bad RequestThe request was invalid or cannot be otherwise served. An accompanying error message will explain further.
401UnauthorizedThe request requires user authentication.
403ForbiddenThe request was understood, but it has been refused or access is denied. An accompanying error message will explain further.
404Not FoundThe URI requested is invalid or the resource requested does not exist.
409ConflictThe request could not be completed, due to a conflict with the current state of the resource.
429Too Many RequestsReturned when a request cannot be served, due to the API’s rate limit having been exhausted for the client.
500Internal Server ErrorSomething is broken.
503Service UnavailableThe API servers are working, but overloaded. Try again later.

Error messages

When the API returns error messages, it returns error details in JSON format.

    "code": "000262",
    "description": "Unknown user"