The Case object
Every field on a case, as the API returns it.
A case is a support request about one quote, shared between your team and Prets. A merchant feedback case is one you raise with Prets, a Prets feedback case is one Prets raises with you, and a general case is a support question without a request type. A quote has at most one open case raised by your team at a time. state says whether the case is still open; while it is, waitingOn says whose move it is. The case holds metadata and lifecycle only: the conversation is its list of case messages.
Events
Prets sends these events when a case or its messages change. Receive them with an event destination.
- case.createdA Case became fetchable. Appearance fact: a re-shown Case repeats this type for the same caseId.
- case.updatedA fetchable Case changed in a way GET /v1/cases/{caseId} would show, including reopen.
- case.closedCase state crossed into closed.
- case.message.repliedA Case message was added, except the opening request which case.created already covers.
Attributes
- caseIdstring
Platform case id (
cas_{ULID}) - quoteobject
Quote this case is attached to
Show child attributes
- quoteIdstring
Quote this resource is linked to
- typeenum
Merchant-facing case category
Possible values:
general,merchant_feedback,prets_feedback The specific request; present on feedback cases
Show 14 possible values
Cancel Application,Reschedule Meeting,Contact Customer,Application Final,Other,Customer Unreachable,Quote Under Consideration,Customer No Show & Unreachable,Customer No Show & VM,Cancellation Offer Requested,Schedule Installation,General Question,Compliance/Risk,Documents Requested- subjectstring
Case subject
Read-only mirror of the opening request. The conversation lives on
/messages.- stagestring
Informational Salesforce stage string. Not a published enum — switch on
stateandwaitingOn. - createdAtstring (date-time)
When the case was created (ISO 8601)
Follow-up date on the Case (
YYYY-MM-DD). Present on Prets Feedback parks. Expiry does not close the Case.Name of the portal user who created the case
- updatedAtstring (date-time)
When the case was last modified (ISO 8601)
- stateenum
When
stateisopen: The Case is still in playWhen
stateisclosed: The Case has been closedPossible values:
open,closed - waitingOnenum
When
waitingOnis notnone: Party that must act nextNo party is waiting — typical of New before the first handoff
When
stateisclosed: Closed Cases always projectnonerather than dropping the fieldPossible values:
merchant,prets,none Only when
waitingOnis notnoneWhen
waitingOnlast changed. Present only whenwaitingOnis notnone.Only when
stateisclosedWhy the Case was closed, when one was given
Possible values:
resolved,dismissed,withdrawnOnly when
stateisclosedWhen the Case was closed (ISO 8601)