Rivier/ Reference/ workspace

Make a template the default of its kind (isDefault false clears it)

post/org/{orgId}/templates/{id}/default

Make a template the default of its kind (isDefault false clears it). Needs an admin.

Before you call

Credential
Authorization: Bearer $KEY
Scope
workspace:write
Sdk
workspace.orgTemplate.default
Cli
templates default

Parameters

  • orgIdstring (uuid)required
    In the path
  • idstring (uuid)required
    In the path

Request bodyapplication/json, required

  • isDefaultboolean
    Default: true.

Responses

  • 200application/json
    Success
    • templateobjectrequired
      • idstring (uuid)required
      • organizationIdstring (uuid)required
      • kindstringrequired
        One of: quote, proposal, invoice.
      • namestringrequired
      • layoutstringrequired
        One of: minimal, classic, modern, bold.
      • useCasestringrequired
      • languagestringrequired
      • isDefaultbooleanrequired
      • blockslist of objectrequired
        • idstringrequired
        • typestringrequired
      • linePresetslist of objectrequired
        • descriptionstringrequired
        • quantitynumberrequired
        • unitstringrequired
        • unitPriceMinornumberrequired
      • termsstringrequired
      • paymentDetailsstringrequired
      • emailSubjectstringrequired
      • emailBodystringrequired
      • createdBystringrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • archivedAtstring or nullrequired
  • 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