Salesforce Case

Represents a case, which is a customer issue or problem. Cases are used to track and manage customer support inquiries, complaints, and service requests. Cases can be associated with accounts, contacts, and assets.

CloudCRMCustomer ManagementEnterpriseSales

Properties

Name Type Description
Id string Unique 18-character Salesforce record identifier
IsDeleted boolean Indicates whether the record has been moved to the Recycle Bin
MasterRecordId stringnull If deleted as result of a merge, ID of the master record
CaseNumber string Auto-number identifier for the case
ContactId stringnull ID of the associated Contact
AccountId stringnull ID of the associated Account
AssetId stringnull ID of the associated Asset
ParentId stringnull ID of the parent case (for case hierarchies)
SuppliedName stringnull Name of the contact supplied during case creation via Web-to-Case
SuppliedEmail stringnull Email address supplied during case creation
SuppliedPhone stringnull Phone number supplied during case creation
SuppliedCompany stringnull Company name supplied during case creation
Type stringnull Type of case
Status string Status of the case
Reason stringnull Reason the case was created
Origin stringnull Source of the case
Subject stringnull Subject of the case
Priority stringnull Priority of the case
Description stringnull Full description of the case
IsClosed boolean Indicates whether the case is closed
ClosedDate stringnull Date and time when the case was closed
IsEscalated boolean Indicates whether the case has been escalated
OwnerId string ID of the user or queue that owns the case
CreatedDate string Date and time when this record was created
CreatedById string ID of the user who created this record
LastModifiedDate string Date and time when this record was last modified
LastModifiedById string ID of the user who last modified this record
SystemModstamp string
ContactPhone stringnull Phone number of the associated contact
ContactMobile stringnull Mobile phone number of the associated contact
ContactEmail stringnull Email of the associated contact
ContactFax stringnull Fax of the associated contact
Comments stringnull Internal comments associated with this case
LastViewedDate stringnull
LastReferencedDate stringnull
attributes object
View JSON Schema on GitHub

JSON Schema

salesforce-sales-cloud-case-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.salesforce.com/schemas/sales-cloud/case.json",
  "title": "Salesforce Case",
  "description": "Represents a case, which is a customer issue or problem. Cases are used to track and manage customer support inquiries, complaints, and service requests. Cases can be associated with accounts, contacts, and assets.",
  "type": "object",
  "properties": {
    "Id": {
      "type": "string",
      "description": "Unique 18-character Salesforce record identifier",
      "pattern": "^[a-zA-Z0-9]{18}$",
      "readOnly": true
    },
    "IsDeleted": {
      "type": "boolean",
      "description": "Indicates whether the record has been moved to the Recycle Bin",
      "readOnly": true
    },
    "MasterRecordId": {
      "type": ["string", "null"],
      "description": "If deleted as result of a merge, ID of the master record",
      "readOnly": true
    },
    "CaseNumber": {
      "type": "string",
      "description": "Auto-number identifier for the case",
      "readOnly": true
    },
    "ContactId": {
      "type": ["string", "null"],
      "description": "ID of the associated Contact"
    },
    "AccountId": {
      "type": ["string", "null"],
      "description": "ID of the associated Account"
    },
    "AssetId": {
      "type": ["string", "null"],
      "description": "ID of the associated Asset"
    },
    "ParentId": {
      "type": ["string", "null"],
      "description": "ID of the parent case (for case hierarchies)"
    },
    "SuppliedName": {
      "type": ["string", "null"],
      "description": "Name of the contact supplied during case creation via Web-to-Case",
      "maxLength": 80
    },
    "SuppliedEmail": {
      "type": ["string", "null"],
      "description": "Email address supplied during case creation",
      "format": "email",
      "maxLength": 80
    },
    "SuppliedPhone": {
      "type": ["string", "null"],
      "description": "Phone number supplied during case creation",
      "maxLength": 40
    },
    "SuppliedCompany": {
      "type": ["string", "null"],
      "description": "Company name supplied during case creation",
      "maxLength": 80
    },
    "Type": {
      "type": ["string", "null"],
      "description": "Type of case",
      "enum": [null, "Mechanical", "Electrical", "Electronic", "Structural", "Other"]
    },
    "Status": {
      "type": "string",
      "description": "Status of the case",
      "enum": ["New", "Working", "Escalated", "Closed"]
    },
    "Reason": {
      "type": ["string", "null"],
      "description": "Reason the case was created",
      "enum": [null, "Installation", "Equipment Complexity", "Performance", "Breakdown", "Equipment Design", "Feedback", "Other"]
    },
    "Origin": {
      "type": ["string", "null"],
      "description": "Source of the case",
      "enum": [null, "Phone", "Email", "Web"]
    },
    "Subject": {
      "type": ["string", "null"],
      "description": "Subject of the case",
      "maxLength": 255
    },
    "Priority": {
      "type": ["string", "null"],
      "description": "Priority of the case",
      "enum": [null, "High", "Medium", "Low"]
    },
    "Description": {
      "type": ["string", "null"],
      "description": "Full description of the case"
    },
    "IsClosed": {
      "type": "boolean",
      "description": "Indicates whether the case is closed",
      "readOnly": true
    },
    "ClosedDate": {
      "type": ["string", "null"],
      "format": "date-time",
      "description": "Date and time when the case was closed",
      "readOnly": true
    },
    "IsEscalated": {
      "type": "boolean",
      "description": "Indicates whether the case has been escalated",
      "default": false
    },
    "OwnerId": {
      "type": "string",
      "description": "ID of the user or queue that owns the case"
    },
    "CreatedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when this record was created",
      "readOnly": true
    },
    "CreatedById": {
      "type": "string",
      "description": "ID of the user who created this record",
      "readOnly": true
    },
    "LastModifiedDate": {
      "type": "string",
      "format": "date-time",
      "description": "Date and time when this record was last modified",
      "readOnly": true
    },
    "LastModifiedById": {
      "type": "string",
      "description": "ID of the user who last modified this record",
      "readOnly": true
    },
    "SystemModstamp": {
      "type": "string",
      "format": "date-time",
      "readOnly": true
    },
    "ContactPhone": {
      "type": ["string", "null"],
      "description": "Phone number of the associated contact",
      "readOnly": true
    },
    "ContactMobile": {
      "type": ["string", "null"],
      "description": "Mobile phone number of the associated contact",
      "readOnly": true
    },
    "ContactEmail": {
      "type": ["string", "null"],
      "description": "Email of the associated contact",
      "readOnly": true
    },
    "ContactFax": {
      "type": ["string", "null"],
      "description": "Fax of the associated contact",
      "readOnly": true
    },
    "Comments": {
      "type": ["string", "null"],
      "description": "Internal comments associated with this case"
    },
    "LastViewedDate": {
      "type": ["string", "null"],
      "format": "date-time",
      "readOnly": true
    },
    "LastReferencedDate": {
      "type": ["string", "null"],
      "format": "date-time",
      "readOnly": true
    },
    "attributes": {
      "type": "object",
      "properties": {
        "type": {
          "type": "string",
          "const": "Case"
        },
        "url": {
          "type": "string"
        }
      }
    }
  },
  "required": ["Status"]
}