Make a template

post/org/{orgId}/templates

Make a template: by hand, from a gallery starter (fromGallery), or from a document's content (a body with lines, which drops any tax field on them). Editor and above.

Before you call

Credential: Authorization: Bearer $KEY
Scope: workspace:write
Mcp: rivier_templates_create
Graphql: Mutation.workspaceOrgTemplateCreate
Sdk: workspace.orgTemplate.create
Cli: templates create

Parameters

orgIdstring (uuid)required
In the path

Request bodyapplication/json, required

object

Responses

201application/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

Example request

curl -X POST 'https://api.rivier.ai/org/{orgId}/templates' \
  -H 'Authorization: Bearer $KEY' \
  -H 'Content-Type: application/json' \
  -d '{
  "kind": "quote",
  "name": "string"
}'

$KEY stands for your own key. No key is shown or kept on this site.

This page as Markdown