Issues and Warnings

There are three kinds of issues that can be reported for a given request:

    • An issue caused the entire request to be rejected.
    • An item is rejected, but other items present in the request are accepted (e.g., one invalid Product List item).
    • A field is rejected, but the item otherwise is accepted (e.g., invalid website URL in a Location).
    • The request did not adhere to our best practices or recommendations, but the data was accepted anyway (e.g., data was sent that may cause some listings to become unavailable, a deprecated API was used, or we changed the format of a field’s content to meet our requirements).

Status Codes

  • 200 OK
    • Either there are no errors or warnings, or the only issues are of type WARNING.
  • 207 Multi-Status
    • There are errors of type itemError or fieldError (but none of type requestError).
  • 400 Bad Request
    • A parameter is invalid, or a required parameter is missing. This includes the case where no API key is provided and the case where a resource ID is specified incorrectly in a path.
    • This status is if any of the response errors are of type requestError.
  • 401 Unauthorized
    • The API key provided is invalid.
  • 403 Forbidden
    • The requested information cannot be viewed by the acting user.
  • 404 Not Found
    • The endpoint does not exist.
  • 405 Method Not Allowed
    • The request is using a method that is not allowed (e.g., POST with a GET-only endpoint).
  • 409 Conflict
    • The request could not be completed in its current state.
    • Use the information included in the response to modify the request and retry.
  • 429 Too Many Requests
    • You have exceeded your rate limit / quota.
  • 500 Internal Server Error
    • Yext’s servers are not operating as expected. The request is likely valid but should be resent later.
  • 504 Timeout
    • Yext’s servers took too long to handle this request, and it timed out.