Praecise Platform
Menu

Rivier/ Reference/ workspace

Workspace org template preview

post/org/{orgId}/templates/preview

The renderable view of a template or starter with the organization's branding and sample figures; nothing is saved.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:write
Mcp
rivier_templates_preview
Graphql
Mutation.workspaceOrgTemplatePreview
Sdk
workspace.orgTemplate.preview
Cli
templates preview

Parameters

  • orgIdstring (uuid)required
    In the path

Request bodyapplication/json, required

  • templateIdstring (uuid)
  • galleryKeystring
    At most 80 characters.
  • languagestring
    One of: en, dv, ar.
  • layoutstring
    One of: minimal, classic, modern, bold.
  • kindstring
    One of: quote, proposal, invoice.
  • clientobject
    • namestring
      Default: . At most 200 characters.
    • addressstring
      Default: . At most 1000 characters.
    • emailstring
      Default: . At most 254 characters.
  • currencystring
    Default: usd. Pattern: ^[a-z]{3}$.

Responses

  • 200application/json
    Success
    • previewobjectrequired
    • 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