Case

This object contains the following attributes:

Field	Type	Description
id	string, core	A unique identifier for the case.
chat	object	The chat object for the case.
revision	unit, core	The revision number used for platform-level versioning.
parameters	object	Represents the parameter object, which contains a set of parameter values. Example: [ { "id": "PAR-1344-4634", "name": "Priority", "scope": "Case", "phase": "request", "constraints":{ "visibleToReporter": true, }, "externalId": "ext-id-1234", "value": "Priority 1" } ]
status	enum, core	Represents the case status. Allowed values are: Processing Querying Completed
awaiting	boolean	Allows an Operations user to mark the case as awaiting. This value is not visible to client or vendor account users.
queryPrompt	string	If a case is moved to querying, the participant, usually the operator, can provide an additional message to explain what is needed from the other side.
queue	object, core	The queue that the case is currently in. This is not read-only, as the queue can change (the case can be transferred). Example: { "id": "HQU-1234-1234", "name": "Business Onboarding", "workflow": "HWF-1234-4568" }
assignee	object, core	Represents the actor responsible for managing the case. Usually, a user from the account that owns the queue. Any assigned actor is automatically added as a participant in the related case chat. Example: { "id": "USR-6375-2499", "email": "[e-mail]", "firstName": "Jane", "lastName": "Doe" }
account	object, core	Represents the account from which the reporter opened the case. When a case is created by an operations account user on behalf of a client or vendor, this is the account chosen by the operator in the wizard. Example: { "id": "ACC-6685-9632", "name": "Stark Industries" }
reporter	object, core	Represents the actor who is reporting the case. If not provided when the case is created, the reporter defaults to the identity from the request claim. When an operator creates a case on behalf of a client or vendor, that operator becomes the reporter. Any actor designated as the reporter is automatically added as a participant in the related case chat. Example: { "id": "USR-6375-2499", "name": "Jane Doe" }
audit	object	Represents the audit object.