Skip to content

Batch Quote Action

POST
/quotes/batch

Archive, expire or revoke up to 200 quotes.

READ THE PER-ROW RESULT, not the HTTP status. Each quote runs in its own transaction, so a 200 here means “the batch ran”, not “every quote moved”: an out-of-scope id comes back forbidden, an unknown one error, and a quote whose status makes the action meaningless comes back skipped.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Archive, expire or revoke up to 200 quotes.

Each quote runs in its OWN transaction and reports its own outcome, so one bad row does not roll back the rest. The per-row result is the whole point of the endpoint - read it rather than the HTTP status.

object
action
required

What to do to every quote in the list.

string
Allowed values: archive expire revoke
quote_ids
required

Quote ids. An out-of-scope or unknown id is reported per-row, not fatal.

Array<string>
>= 1 items <= 200 items

Responses

200

Successful Response

object
data
required

An open envelope for a LIST result, so a bare list keeps its shape.

object
items
Array
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string