Get Metadata of an Opportunity Type

Returns the properties of all the fields for the selected opportunity type. To obtain the Opportunity Type Code, navigate to My Profile>Settings>Opportunities>Opportunity Types, and against an opportunity type, you’ll find the code.

 

API URL

GET
https://{host}/v2/OpportunityManagement.svc/GetOpportunityTypeMetadata?accessKey=AccessKey&secretKey=SecretKey&code=code
Copy URL

URL Parameters

Parameter Description
code This is the event code for the opportunity type. You can find this by navigating to My Profile>Settings>Opportunities>Opportunity Type. It is listed under "Code".

Response

200 OK

Content-Type: application/json

{
   "AllowAttachments":false,
   "CanDelete":false,
   "Description":"",
   "DisplayName":"Loan",
   "EventCode":12005,
   "Fields":[
      {
         "SchemaName":"ActivityEvent_Note",
         "InternalName":"ActivityEvent_Note",
         "DisplayName":"Notes",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":0,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"Status",
         "InternalName":"Status",
         "DisplayName":"Status",
         "Value":null,
         "DataType":"SearchableDropdown",
         "IsMandatory":true,
         "ShowInForm":true,
         "Sequence":2,
         "ParentField":"",
         "OptionSet":"[{\"IsDefault\":true,\"Text\":\"\",\"Value\":\"Open\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":0,\"BackgroundColor\":\"#FFFB83\",\"FontColor\":\"#A08427\"},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Won\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":1,\"BackgroundColor\":\"#A5E887\",\"FontColor\":\"#347715\"},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Lost\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":2,\"BackgroundColor\":\"#FFD4D0\",\"FontColor\":\"#E31D00\"}]",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunityStatus",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"Owner",
         "InternalName":"Owner",
         "DisplayName":"Owner",
         "Value":null,
         "DataType":"ActiveUsers",
         "IsMandatory":true,
         "ShowInForm":true,
         "Sequence":1,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"Owner",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_1",
         "InternalName":"mx_Custom_1",
         "DisplayName":"Opportunity Name",
         "Value":null,
         "DataType":"String",
         "IsMandatory":true,
         "ShowInForm":true,
         "Sequence":3,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"Title",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_2",
         "InternalName":"mx_Custom_2",
         "DisplayName":"Stage",
         "Value":null,
         "DataType":"SearchableDropdown",
         "IsMandatory":true,
         "ShowInForm":true,
         "Sequence":4,
         "ParentField":"Status",
         "OptionSet":"",
         "DependentOptionSet":"[{\"Parent\":\"Open\",\"Options\":[{\"IsDefault\":true,\"Text\":\"\",\"Value\":\"Prospecting\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":0},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Qualification\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":1},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Need Analysis\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":2},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Proposal\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":3},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Negotiation\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":4}]},{\"Parent\":\"Won\",\"Options\":[{\"IsDefault\":true,\"Text\":\"\",\"Value\":\"Closed - Won\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":0}]},{\"Parent\":\"Lost\",\"Options\":[{\"IsDefault\":true,\"Text\":\"\",\"Value\":\"Closed - Lost\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":0},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Decided not to buy\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":1},{\"IsDefault\":false,\"Text\":\"\",\"Value\":\"Budget constraints\",\"CanDelete\":1,\"CanEdit\":1,\"IsLastOption\":0,\"Order\":2}]}]",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunityReason",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_3",
         "InternalName":"mx_Custom_3",
         "DisplayName":"Source",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":4,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunitySourceName",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_20",
         "InternalName":"mx_Custom_20",
         "DisplayName":"Campaign",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":5,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunitySourceCampaign",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_21",
         "InternalName":"mx_Custom_21",
         "DisplayName":"Medium",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":6,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunitySourceMedium",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_22",
         "InternalName":"mx_Custom_22",
         "DisplayName":"Term",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":7,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunitySourceTerm",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_23",
         "InternalName":"mx_Custom_23",
         "DisplayName":"Content",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":8,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunitySourceContent",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_5",
         "InternalName":"mx_Custom_5",
         "DisplayName":"Description",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":10,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"Description",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_6",
         "InternalName":"mx_Custom_6",
         "DisplayName":"Expected Deal Size",
         "Value":null,
         "DataType":"Number",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":11,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"ExpectedDealSize",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_7",
         "InternalName":"mx_Custom_7",
         "DisplayName":"Actual Deal Size",
         "Value":null,
         "DataType":"Number",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":12,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"ActualDealSize",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_8",
         "InternalName":"mx_Custom_8",
         "DisplayName":"Expected Closure Date",
         "Value":null,
         "DataType":"DateTime",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":13,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"ExpectedClosureDate",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_9",
         "InternalName":"mx_Custom_9",
         "DisplayName":"Actual Closure Date",
         "Value":null,
         "DataType":"DateTime",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":14,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"ActualClosureDate",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_10",
         "InternalName":"mx_Custom_10",
         "DisplayName":"Product",
         "Value":null,
         "DataType":"Product",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":15,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"Product",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_11",
         "InternalName":"mx_Custom_11",
         "DisplayName":"Origin",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":16,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"Origin",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"ModifiedOn",
         "InternalName":"ModifiedOn",
         "DisplayName":"Modified On",
         "Value":null,
         "DataType":"DateTime",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":22,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":true,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"ModifiedOn",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"ModifiedBy",
         "InternalName":"ModifiedBy",
         "DisplayName":"Modified By",
         "Value":null,
         "DataType":"ActiveUsers",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":23,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":true,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"ModifiedBy",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"CreatedOn",
         "InternalName":"CreatedOn",
         "DisplayName":"Created On",
         "Value":null,
         "DataType":"DateTime",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":24,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":true,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"CreatedOn",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"CreatedBy",
         "InternalName":"CreatedBy",
         "DisplayName":"Created By",
         "Value":null,
         "DataType":"ActiveUsers",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":25,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":true,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"CreatedBy",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_19",
         "InternalName":"mx_Custom_19",
         "DisplayName":"Comment",
         "Value":null,
         "DataType":"String",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":26,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":true,
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"OpportunityComment",
         "CustomObjectType":2,
         "MaxFieldLength":200
      },
      {
         "SchemaName":"mx_Custom_4",
         "InternalName":"mx_Custom_4",
         "DisplayName":"Documents",
         "Value":null,
         "DataType":"CustomObject",
         "IsMandatory":false,
         "ShowInForm":true,
         "Sequence":4,
         "ParentField":"",
         "OptionSet":"",
         "DependentOptionSet":"",
         "IsDefault":false,
         "CustomObjectFormProperties":{
            "FieldProperties":{
               "CustomObjectId":"da2282ec-f74f-11ea-8f2a-0a6d35d1ff1e",
               "FormMetaData":[
                  {
                     "AllowAutoUpdate":false,
                     "BehaviorOnMissingDropdownOption":0,
                     "CustomObjectFormProperties":null,
                     "DataType":"File",
                     "DependentOptionSet":null,
                     "DependentOptionsCSV":null,
                     "DisplayName":"PAN Card",
                     "FileContentProperties":{
                        "AllowedExtensions":[
                           "png",
                           "jpg",
                           "jpeg",
                           "bmp"
                        ],
                        "AllowedMaxFiles":"10",
                        "AllowedMaxSize":"1",
                        "BlockedExtensions":null,
                        "Configuration":null,
                        "PreSignedURLExpiry":null,
                        "RelativePath":null,
                        "ContentType":"Images"
                     },
                     "FileStorageVersion":0,
                     "FileURL":null,
                     "ImportOperationStatus":0,
                     "IncludeOthersOption":false,
                     "InternalName":null,
                     "IsDefault":false,
                     "IsDerived":false,
                     "IsLargeOptionSetImportAttempted":false,
                     "IsMandatory":false,
                     "IsOthersValue":false,
                     "IsReadOnly":false,
                     "LargeOptionSetImportTransactionId":null,
                     "LeadFieldDetails":null,
                     "LeadFieldProperties":null,
                     "MaxFieldLength":200,
                     "OptionSet":null,
                     "OptionsCSV":null,
                     "ParentField":null,
                     "SchemaName":"mx_CustomObject_1",
                     "Sequence":0,
                     "ShowInForm":true,
                     "Value":null
                  },
                  {
                     "AllowAutoUpdate":false,
                     "BehaviorOnMissingDropdownOption":0,
                     "CustomObjectFormProperties":null,
                     "DataType":"File",
                     "DependentOptionSet":null,
                     "DependentOptionsCSV":null,
                     "DisplayName":"Aadhaar",
                     "FileContentProperties":{
                        "AllowedExtensions":[
                           "png",
                           "jpg",
                           "jpeg",
                           "bmp"
                        ],
                        "AllowedMaxFiles":"10",
                        "AllowedMaxSize":"1",
                        "BlockedExtensions":null,
                        "Configuration":null,
                        "PreSignedURLExpiry":null,
                        "RelativePath":null,
                        "ContentType":"Images"
                     },
                     "FileStorageVersion":0,
                     "FileURL":null,
                     "ImportOperationStatus":0,
                     "IncludeOthersOption":false,
                     "InternalName":null,
                     "IsDefault":false,
                     "IsDerived":false,
                     "IsLargeOptionSetImportAttempted":false,
                     "IsMandatory":false,
                     "IsOthersValue":false,
                     "IsReadOnly":false,
                     "LargeOptionSetImportTransactionId":null,
                     "LeadFieldDetails":null,
                     "LeadFieldProperties":null,
                     "MaxFieldLength":200,
                     "OptionSet":null,
                     "OptionsCSV":null,
                     "ParentField":null,
                     "SchemaName":"mx_CustomObject_2",
                     "Sequence":0,
                     "ShowInForm":true,
                     "Value":null
                  }
               ]
            },
            "FormLayout":{
               "AvailableFields":[
                  
               ],
               "Sections":[
                  {
                     "DisplayName":"Custom Field Set Details",
                     "Fields":[
                        {
                           "Colspan":2,
                           "SchemaName":"mx_CustomObject_1"
                        },
                        {
                           "Colspan":2,
                           "SchemaName":"mx_CustomObject_2"
                        }
                     ]
                  }
               ]
            },
            "FileStorageVersion":-1
         },
         "IsReadOnly":false,
         "RenderType":"",
         "ExportAsPlainText":false,
         "IsMultiSelectDropdown":false,
         "IncludeOthersOption":false,
         "BehaviorOnMissingDropdownOption":0,
         "IsOthersValue":false,
         "InternalSchemaName":"",
         "CustomObjectType":2,
         "MaxFieldLength":200
      }
   ],
   "FormLayout":"{\"FormLayout\":{\"Sections\":[{\"DisplayName\":\"Opportunity Details\",\"Fields\":[{\"SchemaName\":\"ActivityEventName\",\"Colspan\":2},{\"SchemaName\":\"AssociatedEntityIdName\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_1\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_6\",\"Colspan\":1},{\"SchemaName\":\"mx_Custom_8\",\"Colspan\":1},{\"SchemaName\":\"mx_Custom_10\",\"Colspan\":1},{\"SchemaName\":\"Owner\",\"Colspan\":1},{\"SchemaName\":\"Status\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_3\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_5\",\"Colspan\":2},{\"SchemaName\":\"ActivityEvent_Note\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_4\",\"Colspan\":2}]}],\"AvailableFields\":[{\"SchemaName\":\"mx_Custom_7\",\"Colspan\":1},{\"SchemaName\":\"mx_Custom_9\",\"Colspan\":1},{\"SchemaName\":\"mx_Custom_11\",\"Colspan\":1},{\"SchemaName\":\"ModifiedOn\",\"Colspan\":1},{\"SchemaName\":\"ModifiedBy\",\"Colspan\":1},{\"SchemaName\":\"CreatedOn\",\"Colspan\":1},{\"SchemaName\":\"CreatedBy\",\"Colspan\":1}]}}",
   "ID":"311d2e30-f7df-11ea-a132-0a6d35d1ff1e",
   "IsAuditEnable":true,
   "ModifiedBy":"a4dfa1c5-c6d2-11ea-92ae-0a6d35d1ff1e",
   "ModifiedOn":"/Date(1600236001000+0000)/",
   "Name":"Loan",
   "PluralName":"Loans",
   "Properties":null,
   "Score":0,
   "VCardFormLayout":"{\"FormLayout\":{\"VCardColor\":\"#557488\",\"Sections\":[{\"DisplayName\":\"Opportunity VCard\",\"Fields\":[{\"SchemaName\":\"mx_Custom_1\",\"Colspan\":2},{\"SchemaName\":\"Status\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_10\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_6\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_7\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_8\",\"Colspan\":2}]},{\"DisplayName\":null,\"Fields\":[{\"SchemaName\":\"Owner\",\"Colspan\":2},{\"SchemaName\":\"ModifiedOn\",\"Colspan\":2},{\"SchemaName\":\"ModifiedBy\",\"Colspan\":2}]},{\"DisplayName\":\"Related Lead\",\"Fields\":[{\"SchemaName\":\"FirstName\",\"Colspan\":2},{\"SchemaName\":\"LastName\",\"Colspan\":2},{\"SchemaName\":\"ProspectStage\",\"Colspan\":2},{\"SchemaName\":\"Phone\",\"Colspan\":2},{\"SchemaName\":\"EmailAddress\",\"Colspan\":2},{\"SchemaName\":\"LeadAge\",\"Colspan\":2},{\"SchemaName\":\"OwnerId\",\"Colspan\":2},{\"SchemaName\":\"ModifiedOn\",\"Colspan\":2},{\"SchemaName\":\"ModifiedByName\",\"Colspan\":2}]}],\"AvailableFields\":[{\"SchemaName\":\"mx_Custom_3\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_5\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_9\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_11\",\"Colspan\":2},{\"SchemaName\":\"CreatedOn\",\"Colspan\":2},{\"SchemaName\":\"CreatedBy\",\"Colspan\":2},{\"SchemaName\":\"ActivityEvent_Note\",\"Colspan\":2},{\"SchemaName\":\"mx_Custom_4\",\"Colspan\":2}]}}"
}

HTTP Response Code

Code Description
200 OK

This is the status code for successful API call.

401 Unauthorized

The API call was made with invalid access credentials. Check your AccessKey and SecretKey.

400 Bad Request

The message body on the request is not as per API specification. Make sure that content type is set to “application/json” and the JSON body has correct attribute names and structure.

404 Not Found

The API could not be found. Please check the API signature.

429 Too Many Requests

API calls exceeded the limit of 25 in 5 second(s)

500 Internal Server Error

The API called failed. There could be many reasons for it. Check the exception message to get more details.