Skip to main content
Quotes

Archive a quote

POST
/quotes/{id}/archive
Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

idstringrequired

Response

application/json

The archived quote. Already archived: unchanged.

X-RateLimit-Limitintegerheader

The company's daily request limit.

X-RateLimit-Remainingintegerheader

Requests left in the current daily window.

X-RateLimit-Resetstringheader

When the daily window resets (UTC ISO timestamp).

X-RateLimit-Minute-Limitintegerheader

The company's per-minute request limit.

X-RateLimit-Minute-Remainingintegerheader

Requests left in the current minute.

X-RateLimit-Minute-Resetstringheader

When the minute window resets (UTC ISO timestamp).

accepted_option_idstring | nullrequired
approved_atstring | nullrequired
archivedbooleanrequired
client_urlstring | nullrequired

The client portal link for the quote. Null when it cannot be built.

contactobject | nullrequired

The lead or customer the quote is for.

created_atstringrequired
idstringrequired
internal_notesstring | nullrequired
optionsobject[]required
quote_numberinteger | nullrequired
rejected_atstring | nullrequired
sent_atstring | nullrequired
service_typesstring[]required
sold_bystring | nullrequired

The salesperson user id. Null for quotes created through the API.

statusenum<string>required
Available options: draft, sent, approved, rejected, modification_requested, converted
totalnumber | nullrequired

The accepted option total once accepted, otherwise the recommended option total. Null when none can be calculated.

viewed_atstring | nullrequired