Skip to main content
PUT
Replace proposal details

Authorizations

Authorization
string
header
required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Path Parameters

key
string<uuid>
required

Body

userKey
string<uuid>
name
string | null
note
string | null
welcomeMessageID
integer<int32> | null
startDate
string<date-time> | null
endDate
string<date-time> | null
startOnAcceptance
boolean | null
currencyID
integer<int32> | null
lengthID
integer<int32> | null
expiryDate
string<date-time> | null
terms
integer<int32> | null
termsDetailsOverride
string | null
stpID
integer<int32> | null
stpDetailsOverride
string | null
documents
object[] | null
attachmentID
integer<int32> | null
coverPageID
integer<int32> | null
emailSubject
string | null
emailContent
string | null
packages
object[] | null
showServiceMenu
boolean | null
serviceGrouping
integer<int32> | null
sendSms
boolean | null
requestPaymentDetails
boolean | null
paymentDetailsType
integer<int32> | null
payerID
string | null
businessSignatoryUserKey
string<uuid> | null
requiresApproval
boolean | null
approverUserKey
string<uuid> | null
includeCdd
boolean | null

Response

OK

engagementKey
string<uuid>
statusName
string | null
billingNeedsReview
boolean
pricing
object
Example:
section
unknown