OptionalcauseOptionalcodean application-specific error code, expressed as a string value.
OptionalhelpAdditional details related to the error that may help the user troubleshoot the issue. If set by the user via the Error constructor, the user provided value will override any automated help message set by the Error class.
OptionalmetaAny additional properties which will be appended to the Error's meta property
OptionalrequestRelevant for integration errors involving a network call, the requestOptions property
details the request options that resulted in the specified error. The requestOptions property will automatically
have sensitive authentication headers stripped.
By default, the following paths are sanitized:
Additional paths can be sanitized by using the requestOptionsToSanitize property.
OptionalrequestList of paths in JSON dot notation to sanitize in the requestOptions object
OptionalstatusThe HTTP status code applicable to this error, expressed as a string value.
Optionaltitlea short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem except for purposes of localization. If omitted, the title will default to the type of error (e.g., IntegrationError, or ApiRequestError)
The
causeproperty is used to specify thecauseof the error. Typically, this property is used to pass through a related Error instance.