Rivier/ Reference/ shop

A fresh private link to a sent quote, to paste into a message

post/quotes/{id}/link

A fresh private link to a sent quote, to paste into a message; the address is shown once. With replace true the older links stop working.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Mcp
rivier_quotes_link
Graphql
Mutation.shopQuoteLink
Sdk
shop.quote.link
Cli
quotes link

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • daysinteger
    Default: 30. At least 1. At most 365.
  • replaceboolean
    Default: false.

Responses

  • 201application/json
    Success
    • urlstringrequired
    • tokenstringrequired
    • linkobjectrequired
      • idstring (uuid)required
      • kindstringrequired
        One of: quote, proposal, invoice.
      • docIdstring (uuid)required
      • expiresAtstring or nullrequired
      • viewsnumberrequired
      • firstViewedAtstring or nullrequired
      • lastViewedAtstring or nullrequired
      • revokedAtstring or nullrequired
      • createdBystringrequired
      • createdAtstringrequired
      • activebooleanrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown