Skip to main content
Lead use HTTP response codes to indicate the success or failure of an API request.
  • Codes in the 2xx range indicate success
  • Codes in 4xx and 5xx range indicate an error
    • 4xx errors indicate a bad request and are fixable using the information in the error message.
    • 5xx errors indicate an issue with Lead’s servers, (this is rare).
Lead’s errors responses confirm to RFC 7807. Error responses will follow this shape:
{  
    "type": "string",  
    "status": "string",  
    "title": "string",  
    "detail": "string",  
    "code": "string",  
}
FieldDescription
typeThe primary classification of the error.
codeA machine-readable string that represents the specific error encountered.
titleA human-readable string explaining the error. This is meant to be read by a developer, not a machine. The message will change and should not be used programatically. For that use code.
detailA human-readable explanation specific to THIS occurrence of the problem.
statusThe HTTP status code of the error.