STstuut
sales-order-cases

Pause a Sales Order Case's Outreach

Pausing a paused case changes its resume time.

post/v2/sales-order-cases/{case_id}/pause

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

case_idstring required

Request body

resume_atstring date-time

Response

Successful Response

created_atstring date-time required
modified_atstring date-time required
idstring required
type'early_ship' | 'late_delivery' required
resolution'decided' | 'no_response' | 'closed_by_user' required

How a case closed. What the customer decided is on each line's decision.

resolved_atstring date-time required
needs_attentionboolean required

An open case waiting on a teammate. Cleared when the case resolves.

attention_reasonstring nullable required

Why the case needs a teammate, such as asked for a person or outcome unclear. Set exactly when needs_attention is.

current_ship_datestring date required

The date the case's lines shipped by when it was opened: the latest line snapshot for early ship, the earliest for late delivery. Not kept in sync with the lines.

proposed_ship_datestring date nullable required

The ship date offered for the whole case. NULL when the lines carry their own dates or the offer has no date, such as shipping as soon as possible.

touch_countinteger required

Outreach attempts made on this case, by Stuut or a teammate.

last_touch_atstring date-time required
next_touch_atstring date-time required
outreach_pausedboolean required

Outreach waits until resume_outreach_at, or indefinitely when that is NULL.

line_countinteger required

The number of sales order lines the case covers.

summarystring nullable required

Agent-written account of where the case stands, in a few sentences.

summary_staleboolean required

The timeline changed since summary was written, and a rewrite is pending.

channel'email' | 'phone' required
human_callback_requested_atstring date-time required
resume_outreach_atstring date-time required
max_touchesinteger required

The most touches outreach makes on the case.

objectstring required

String representing the object's type. Objects of the same type share the same value.

is_openboolean required

The case is open until it is resolved.

Changes

No recorded changes to this operation across all 1 revision of this API.