Copy Proposal Items
POST /public/proposals//items/copy — Copies one or more items into one or more destination area options within the same proposal.
ProposalItemIds and the targets in DestinationAreaOptionIds. Every destination receives a copy of every listed item, so three items and two destinations produce six new items. Copies are appended to the end of each destination option. Every destination option and item must belong to the proposal, and a repeated id in either list returns 400 rather than being ignored.
CopyNestedItems defaults to true, so children are copied under their new parent and appear in the response alongside them. The copies are new proposal items with their own ids: later edits to the originals do not follow them.
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
Unique ID of the proposal (not the proposal number).
Body
Proposals Service
Area options to copy the items to. Each option must belong to the proposal, and duplicate ids return 400 rather than being ignored. Maximum 256.
Ids of the proposal items to copy. Each item must belong to the proposal, and duplicate ids return 400 rather than being ignored. Maximum 256.
(Optional) Whether nested (child) items copy along with their parent. Defaults to true.
Response
Success
Unique numeric identifier of the proposal item
Identifier of the catalog, labor, custom, or fee item this proposal item was created from
UTC timestamp when the proposal item was created
Quantity of the proposal item
Identifier of the parent item when this item is nested under another item
Part, Labor, CustomItem, Fee UTC timestamp when the proposal item was last modified
Brand name of the item
Model value of the item
Name of a Labor item
Short description shown for the proposal item
Client-facing note for the proposal item
Image URL of the item
MSRP amount of the item
Sell price for the proposal item
Supplier cost for the proposal item
UTC timestamp when the supplier cost was last updated
Display name of the supplier assigned to the item.
Total amount for a proposal item
Whether the proposal item is tax exempt
Whether the proposal item is a recurring service
Linked orders created from this proposal item