Salesforce · Schema

Error

An error response from the Salesforce REST API, describing the problem with the request.

Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Properties

Name Type Description
message string Human-readable description of the error.
errorCode string Salesforce error code (e.g., MALFORMED_QUERY, INVALID_FIELD, REQUIRED_FIELD_MISSING).
fields array List of field names related to the error, if applicable (e.g., for field validation errors).
View JSON Schema on GitHub

JSON Schema

salesforce-rest-error-schema.json Raw ↑
{
  "type": "object",
  "description": "An error response from the Salesforce REST API, describing the problem with the request.\n",
  "properties": {
    "message": {
      "type": "string",
      "description": "Human-readable description of the error.",
      "example": "example_value"
    },
    "errorCode": {
      "type": "string",
      "description": "Salesforce error code (e.g., MALFORMED_QUERY, INVALID_FIELD, REQUIRED_FIELD_MISSING).\n",
      "example": "example_value"
    },
    "fields": {
      "type": "array",
      "description": "List of field names related to the error, if applicable (e.g., for field validation errors).\n",
      "example": [],
      "items": {
        "type": "string"
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "Error"
}