Cognito Forms · Schema

Error

An error response from the Cognito Forms API

FormsForm BuilderForm EntriesWorkflow AutomationData CollectionOData

Properties

Name Type Description
Message string A message describing the error
Type string The type of the error
SupportCode string A support code identifying the specific error
Data object Data related to the error
View JSON Schema on GitHub

JSON Schema

error.json Raw ↑
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api.cognitoforms.com/schemas/error.json",
  "title": "Error",
  "description": "An error response from the Cognito Forms API",
  "type": "object",
  "properties": {
    "Message": {
      "description": "A message describing the error",
      "type": "string"
    },
    "Type": {
      "description": "The type of the error",
      "type": "string"
    },
    "SupportCode": {
      "description": "A support code identifying the specific error",
      "type": "string"
    },
    "Data": {
      "description": "Data related to the error",
      "type": "object"
    }
  }
}