Skip to content

Update Quote Template

PUT
/quote-templates/{template_id}

Replace a template. ORG ADMIN.

A PUT, matching the app: the body is the template’s new state, not a patch, so an omitted field is CLEARED rather than left alone.

Authorizations

Parameters

Path Parameters

template_id
required

Template id.

string

Template id.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

A reusable quote template. A CLOSED mirror of QuoteTemplateDTO - the app drops an unrecognised field silently, so an open model here would turn a typo into a template saved without the thing you typed.

object
contract_duration_unit
Any of:
string
Allowed values: months weeks days
contract_duration_value
Any of:
number
>= 0.1 <= 3650
contract_months
Any of:
number
>= 0.1 <= 120
default_line_items
Any of:
Array<object>
object
key
additional properties
any
default_payment_terms
Any of:
string
default_valid_days
Any of:
integer
>= 1 <= 365
description
Any of:
string
document_ids
Any of:
Array<string>
is_default
boolean
name
required
string
>= 1 characters <= 255 characters
terms_override
Any of:
string

Responses

200

Successful Response

object
data
required

An open envelope for a quote, template, contact or job result.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string