Skip to content

Update Quote Settings

PUT
/quote-settings

Org-wide quote branding, terms and sender identity. ORG ADMIN.

GET /quote-settings was already published; this is its write half. Admin because sender_email decides whose name every quote goes out under.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Org-wide quote branding, terms and sender identity.

A CLOSED mirror of the app’s QuoteSettingsDTO, not an open bag. Leaving it open would have achieved nothing: the app model uses pydantic’s default extra behaviour, so an unrecognised branding field is dropped THERE whatever this one does. Closed, the caller gets a 422 naming the field; open, they get a 200 and settings that did not change.

Every field is optional, and the app writes with exclude_none, so a field you omit is left alone rather than blanked.

object
accent_color
Any of:
string
auto_advance_deal_on_quote_send
Any of:
boolean
auto_close_deal_on_acceptance
Any of:
boolean
company_address
Any of:
string
company_email
Any of:
string
company_logo_url
Any of:
string
company_name
Any of:
string
company_phone
Any of:
string
default_billing_provider
Any of:
string
default_payment_terms
Any of:
string
default_privacy
Any of:
string
default_terms
Any of:
string
default_valid_days
Any of:
integer
footer_text
Any of:
string
privacy_url
Any of:
string
quote_acceptance_roam_channel_id
Any of:
string
quote_acceptance_roam_channel_name
Any of:
string
quote_acceptance_roam_notifications_enabled
Any of:
boolean
quote_number_prefix
Any of:
string
required_billing_fields
Any of:
Array<string>
sender_email
Any of:
string
sender_mode
Any of:
string
sender_name
Any of:
string
terms_library
Any of:
Array<object>
object
key
additional properties
any
terms_url
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