Skip to main content

Input fields

accountNumber : ID

The account number associated with the exception, if available.

assignedUserId : Int

The ID of the user assigned to handle this exception.If no user is provided, no user will be assigned to the exception.

category : APIExceptionCategories default: UNKNOWN

Category associated with this exception. Uses the default category if not provided.

channel : String! required

The API client channel where the exception was triggered from.

context : JSONString

Contextual information about the exception, if any.

customerContact : String

The customer contact associated with the exception, if available.

externalIdentifier : String! required

External identifier mapping an entity on the client's database.

keyDate : Date

The key date associated with the exception, if available.

operationsTeamId : Int

The ID of an operations team to handle this exception. If no team is provided, no team will be assigned to the exception.

The priority. Defaults to LOW if not provided.

resolutionStatus : APIExceptionResolutionStatus

The resolution status. Defaults to UNASSIGNED if not provided.

resolutionType : APIExceptionResolutionType

The resolution type. Defaults to UNASSIGNED if not provided.

supplyPointIdentifier : String

The supply point identifier associated with the exception, if available.

Tags associated with this exception if any.

userId : Int

The user ID associated with the exception, if available.

The example data in the variables and responses below are autogenerated values designed to resemble real inputs. They do not represent actual customer data, and in some cases may require additional validation.

Example

{ "accountNumber": "A-C66F5147", "assignedUserId": 82692625, "category": "UNKNOWN", "channel": "debate-current-guess-star-become", "context": {"key": "value"}, "customerContact": "send-bed-off-fund-dinner", "externalIdentifier": "51175891", "keyDate": "1972-04-28", "operationsTeamId": 35073596, "priority": "LOW", "resolutionStatus": "ASSIGNED", "resolutionType": "AUTOMATIC", "supplyPointIdentifier": "52511471", "tags": "MOVE_IN", "userId": 87712954 }