Skip to Content
Prets Developer Portal

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

  • requestTypeenumoptional

    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

  • descriptionstringoptional

    Read-only mirror of the opening request. The conversation lives on /messages.

  • stagestring

    Informational Salesforce stage string. Not a published enum — switch on state and waitingOn.

  • createdAtstring (date-time)

    When the case was created (ISO 8601)

  • expiresAtstring (date)optional

    Follow-up date on the Case (YYYY-MM-DD). Present on Prets Feedback parks. Expiry does not close the Case.

  • createdBystringoptional

    Name of the portal user who created the case

  • updatedAtstring (date-time)

    When the case was last modified (ISO 8601)

  • stateenum

    When state is open: The Case is still in play

    When state is closed: The Case has been closed

    Possible values: open, closed

  • When waitingOn is not none: Party that must act next

    No party is waiting — typical of New before the first handoff

    When state is closed: Closed Cases always project none rather than dropping the field

    Possible values: merchant, prets, none

  • waitingSincestring (date-time)optional

    Only when waitingOn is not none

    When waitingOn last changed. Present only when waitingOn is not none.

  • closeReasonenumoptional

    Only when state is closed

    Why the Case was closed, when one was given

    Possible values: resolved, dismissed, withdrawn

  • closedAtstring (date-time)optional

    Only when state is closed

    When the Case was closed (ISO 8601)