Salesforce · JSON Structure

Salesforce Rest Error Structure

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

Type: object Properties: 3
Fortune 500AIAnalyticsCloudCommerceCRMCustomer ServiceEnterpriseMarketingPlatformSales

Error is a JSON Structure definition published by Salesforce, describing 3 properties. It conforms to the https://json-structure.org/draft/2020-12/schema meta-schema.

Properties

message errorCode fields

Meta-schema: https://json-structure.org/draft/2020-12/schema

JSON Structure

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