Rivier/ Reference/ shop

Shop quote send

post/quotes/{id}/send

Send the quote to the client by mail with its PDF and private link, or with channel link return the link without mail. The first send numbers it and fixes its content; sending again is a resend.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Mcp
rivier_quotes_send
Sdk
shop.quote.send
Cli
quotes send

Parameters

  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • channelstring
    One of: email, link. Default: email.
  • tolist of object
    • namestring
      Default: . At most 200 characters.
    • emailstring (email)required
      At most 254 characters.
    • contactIdstring (uuid)
  • cclist of object
    • namestring
      Default: . At most 200 characters.
    • emailstring (email)required
      At most 254 characters.
    • contactIdstring (uuid)
  • subjectstring
    At most 300 characters.
  • messagestring
    At most 5000 characters.
  • attachPdfboolean
    Default: true.
  • linkDaysinteger
    Default: 30. At least 1. At most 365.
  • validDaysinteger
    Default: 30. At least 1. At most 365.
  • idempotencyKeystring
    At most 120 characters.

Responses

  • 200application/json
    Success
    • sentbooleanrequired
    • channelstringrequired
      One of: email, link.
    • urlstringrequired
    • linkIdstring (uuid)required
    • resendbooleanrequired
    • resultslist of objectrequired
      • emailstringrequired
      • rolestringrequired
        One of: to, cc.
      • okbooleanrequired
      • reasonstring
      • detailstring
    • numberstring or nullrequired
    • statusstringrequired
  • 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