Praecise Platform
Menu

Rivier/ Reference/ shop

Shop invoice send link preview

post/invoices/{id}/send-link/preview

The mail that sending the invoice with its private link would produce, the PDF size and the checks that would stop it; nothing is sent.

Before you call

Credential
Authorization: Bearer $KEY
Scope
shop:write
Mcp
rivier_invoices_send_link_preview
Graphql
Mutation.shopInvoiceSendLinkPreview
Sdk
shop.invoice.sendLinkPreview
Cli
invoices send-link preview

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
    • kindstringrequired
      One of: quote, proposal, invoice.
    • statusstringrequired
    • subjectstringrequired
    • messagestringrequired
    • textstringrequired
    • htmlstringrequired
    • tolist of objectrequired
      • namestring
      • emailstringrequired
    • cclist of objectrequired
      • namestring
      • emailstringrequired
    • pdfobject or nullrequired
    • problemslist of objectrequired
      • codestringrequired
      • severitystringrequired
        One of: error, warning.
      • messagestringrequired
    • readybooleanrequired
    • linkNotestringrequired
  • 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