Update Proposal Client-Facing Description
POST /public/proposals//description — Updates the client-facing project description shown on customer documents. Returns the updated proposal.
Description string and returns the complete updated proposal detail.
409 Conflict is returned if the proposal is in a terminal state that prevents editing. Check the proposal’s status field before attempting updates.Authorizations
Portal application identifier used as part of HMAC-authenticated API requests.
Portal user API key used together with the HMAC signature headers.
Timestamp header included in the signed request to prevent replay attacks.
HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.
Headers
Accept Header
application/json Path Parameters
Proposal Id.
Body
Proposals Service
Description.
Response
Success
Detailed proposal representation
Proposal number unique within the dealer account.
Display name of the proposal.
Unique identifier for the proposal. Use this id for subsequent API calls that reference the proposal.
UTC timestamp when the proposal was initially created. Returned in ISO 8601 format.
UTC timestamp when the proposal was last modified by any user or system process.
UTC timestamp when the proposal was last modified by a human user (not an automated system update).
Undefined, Draft, Submitted, ViewedByClient, Accepted, Declined, Delayed, Completed, EmailFailed, Expired UTC timestamp when the proposal was last submitted to the customer.
UTC timestamp when the customer last opened the proposal viewer link.
Customer contact
Dealer information
Absolute URL of the proposal cover image, when one is available.
The about us text for the company profile.
A description of the project.
The list of areas.
Profit summary for the proposal
Recurring service summary associated with the proposal.
Payment schedule configuration for the proposal, including the customer-facing description and individual payment milestones.
Payment requests already issued for this proposal.
The terms and conditions for the project.
User summary returned within proposal detail responses
UTC timestamp when the client last accepted or declined the proposal. Null if no client decision has been recorded.
UTC timestamp when the proposal last reached a completed state, if applicable.
Financial totals, discounts, tax, and currency values for the proposal
List of change orders associated with this proposal. Each item contains details of scope changes, price adjustments, and approval state.