Change a template

Before you call

Credential

Authorization: Bearer $KEY

Scope

workspace:write

Mcp

rivier_templates_update

Graphql

Mutation.workspaceOrgTemplateUpdate

Sdk

workspace.orgTemplate.update

Cli

templates update

Parameters

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

Request bodyapplication/json, required

• namestring
  At most 120 characters.
• layoutstring
  One of: minimal, classic, modern, bold.
• useCasestring
  At most 60 characters.
• languagestring
  At most 20 characters. Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
• blockslist of object
  • idstringrequired
    At most 60 characters.
  • typestringrequired
    One of: header, parties, meta, intro, section, lines, totals, payment, terms, acceptance, footer.
  • titlestring
    Default: . At most 200 characters.
  • bodystring
    Default: . At most 10000 characters.
• linePresetslist of object
  • descriptionstring
    Default: . At most 500 characters.
  • quantitynumber
    Default: 1. At least 0. At most 1000000.
  • unitstring
    Default: . At most 40 characters.
  • unitPriceMinorinteger
    Default: 0. At least 0. At most 1000000000000.
• termsstring
  At most 20000 characters.
• paymentDetailsstring
  At most 4000 characters.
• emailSubjectstring
  At most 300 characters.
• emailBodystring
  At most 10000 characters.

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