Skip to main content
DELETE
Delete Proposal Items
Removes items from a proposal by id. Pass the ids in ItemIds, repeating the query parameter once per id. Every id must belong to the proposal and appear only once — an unknown id or a repeated one returns 404, and nothing is deleted. There is no partial delete. IncludeAttachments decides what happens to the items nested under those being deleted. It defaults to false, which keeps them: they survive as top-level items in the same area option, taking the position their parent held. Pass true to delete them along with their parent.
Success is an empty 200 or 204; treat both as deleted. Along with refresh item costs, this is one of two item endpoints with no response body, so re-fetch get proposal if you need the remaining items.
To take an item off the client-facing total without removing it, set its quantity to 0 with update quantity instead.

Authorizations

X-MSS-API-APPID
string
header
required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY
string
header
required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE
string
header
required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE
string
header
required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Path Parameters

ProposalId
integer<int32>
required

Unique ID of the proposal (not the proposal number).

Query Parameters

ItemIds
integer[]
required

Ids of the proposal items to delete. Each id must belong to the proposal, and a repeated id returns 404 rather than being ignored.

IncludeAttachments
boolean

(Optional) Also remove the items nested under each deleted item. Defaults to false - nested items are then kept and promoted to top-level items in the same area option.

Response

Success (no body).