Update an existing proposal under /api/v1/proposal. Use the timeline endpoint to change existing dates.
For numeric custom fields, send decimal strings in custom_fields, such as "123.45" or "123,45". Values may have an optional sign and up to two decimal places. Thousands separators, scientific notation, whitespace, and empty values are rejected. Responses return numeric values as top-level field display names with decimal strings using a dot. See numeric custom fields for examples.
PUT/proposal
Authorization
api-auth<api-auth>
api-token<UUID>
api-secret<api-secret>
Use the standard /api/v1 headers for this request.
Send the target project_token inside the JSON body. This endpoint does not use record-token.
API Credentials(save your keys here to make the request examples copy-ready)Hidden by default
Save your domain and request headers once, then reuse them across the current docs session.
Session storage clears when this tab closes. Local storage stays available the next time you open the docs in this browser.
Saved values are used in request examples and code snippets on API pages, including the request domain.
Top-level request body type: object. Send JSON fields shown below.
project_token*string
Acuity Type:text
Default:required
Acuity UI:Project Token
Format uuid
proposal_portfoliostring
Acuity Type:string
Default:""
Acuity UI:Proposal Portfolio Name
namestring
Acuity Type:string
Default:""
Acuity UI:Name
descriptionstring
Acuity Type:text
Default:""
Acuity UI:Description
proposal_requestorstring
Acuity Type:text
Default:""
Acuity UI:Requestor
backgroundstring
Acuity Type:text
Default:""
Acuity UI:Background
Nullable
benefitsstring
Acuity Type:text
Default:""
Acuity UI:Benefits
Nullable
proposal_objectivesstring
Acuity Type:text
Default:""
Acuity UI:Project Objectives
Nullable
recommendationsstring
Acuity Type:text
Default:""
Acuity UI:Recommendations
Nullable
costinteger
Acuity Type:integer
Default:0
Acuity UI:Total Cost (Planned)
financial_benefitsinteger
Acuity Type:integer
Default:nil
Acuity UI:Financial Benefits (Planned)
Nullable
hoursinteger
Acuity Type:integer
Default:0
Acuity UI:Total Project Hours
percent_completeinteger
Acuity Type:0-100
Default:0
Acuity UI:Percent Complete
Range 0..100
start_datestring
Acuity Type:date(yyyy-mm-dd)
Default:nil
Acuity UI:Start Date
Format dateNullable
end_datestring
Acuity Type:date(yyyy-mm-dd)
Default:nil
Acuity UI:Finish Date
Format dateNullable
categorystring
Acuity Type:option
Default:nil
Acuity UI:Category(or your chosen name)
Nullable
departmentstring
Acuity Type:option
Default:nil
Acuity UI:Department(or your chosen name)
Nullable
lifecyclestring
Acuity Type:option
Default:nil
Acuity UI:Phase(or your chosen name)
Nullable
strategic_objectivestring
Acuity Type:option
Default:nil
Acuity UI:Strategic Objectives(or your chosen name)
Nullable
proposal_sponsorstring
Acuity Type:sponsor name
Default:nil
Acuity UI:Project Sponsor(or your chosen name)
Nullable
project_managerstring
Acuity Type:manager name
Default:nil
Acuity UI:Project Manager(or your chosen name)
Nullable
proposal_statestring
Acuity Type:draft | final | ready-for-review
Default:"draft, ready-for-review"
Acuity UI:Proposal State
prioritystring
Acuity Type:custom option
Default:default option
Acuity UI:Priorities(or your chosen name)
Nullable
team_member_1string
Acuity Type:Business Sponsor name
Default:nil
Acuity UI:Business Sponsor(or your chosen name)
Nullable
team_member_2string
Acuity Type:Executive Sponsor name
Default:nil
Acuity UI:Executive Sponsor(or your chosen name)
Nullable
team_member_3string
Acuity Type:IT Project Manager
Default:nil
Acuity UI:IT Project Manager(or your chosen name)
Nullable
team_member_4string
Acuity Type:Product Manager
Default:nil
Acuity UI:Product Manager(or your chosen name)
Nullable
custom_fieldsobject
Company-specific custom field values keyed by field display name. For numeric fields, send decimal strings such as "123.45" or "123,45". An optional sign and up to two decimal places are allowed; thousands separators, scientific notation, whitespace, empty values, and more than two decimal places are rejected with HTTP `400`. Responses expose numeric custom fields as top-level display-name keys with decimal string values using a dot, such as "123.45".