Update Proposal Item Client Note

curl --request POST \
  --url https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/note \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'X-MSS-API-APPID: <api-key>' \
  --header 'X-MSS-API-USERKEY: <api-key>' \
  --header 'X-MSS-CUSTOM-DATE: <api-key>' \
  --header 'X-MSS-SIGNATURE: <api-key>' \
  --data '
{
  "clientNote": "Mounted in the rack behind the display.",
  "setDefault": false,
  "updateAllInstances": false
}
'

import requests

url = "https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/note"

payload = {
    "clientNote": "Mounted in the rack behind the display.",
    "setDefault": False,
    "updateAllInstances": False
}
headers = {
    "Accept": "<accept>",
    "X-MSS-API-APPID": "<api-key>",
    "X-MSS-API-USERKEY": "<api-key>",
    "X-MSS-CUSTOM-DATE": "<api-key>",
    "X-MSS-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Accept: '<accept>',
    'X-MSS-API-APPID': '<api-key>',
    'X-MSS-API-USERKEY': '<api-key>',
    'X-MSS-CUSTOM-DATE': '<api-key>',
    'X-MSS-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    clientNote: 'Mounted in the rack behind the display.',
    setDefault: false,
    updateAllInstances: false
  })
};

fetch('https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/note', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": 81376,
    "parentId": 42344,
    "itemType": "Part",
    "referencedItemId": 63140,
    "createdDate": "2030-08-21T00:22:19Z",
    "lastModifiedDate": "2031-02-06T00:22:19Z",
    "brand": "Sonos",
    "model": "Amp",
    "name": "Installation Labor",
    "shortDescription": "Sonos Amp",
    "clientNote": "Mounted in the rack behind the display.",
    "imageUrl": "https://images.portal.io/catalog/sonos-amp.jpg",
    "msrp": 901.23,
    "sellPrice": 583.78,
    "cost": 759.6,
    "costUpdateDate": "2030-11-10T00:22:19Z",
    "supplier": "Sonos Inc.",
    "quantity": 9.6,
    "total": {
      "amount": 982.49,
      "currency": {
        "code": "USD",
        "symbol": "$"
      },
      "isCombinedPrice": false
    },
    "isTaxExempt": false,
    "isRecurringService": false,
    "linkedOrders": [
      {
        "orderId": 21802,
        "orderNumber": 182,
        "orderNumberSuffix": "A",
        "supplier": "Sonos Inc.",
        "supplierRef": "SN-10420",
        "orderName": "Living Room Sonos Amp",
        "orderStatus": "Submitted"
      }
    ]
  }
]

{
  "responseStatus": {
    "errorCode": "BadRequest",
    "message": "Malformed request body."
  }
}

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Not Authorized. Ensure a valid session cookie or HMAC authentication headers are provided."
  }
}

{
  "responseStatus": {
    "errorCode": "PaymentRequired",
    "message": "The dealer's subscription is inactive or expired. An active subscription is required to use this endpoint."
  }
}

{
  "responseStatus": {
    "errorCode": "Forbidden",
    "message": "You do not have permission for this action."
  }
}

{
  "responseStatus": {
    "errorCode": "NotFound",
    "message": "Proposal or item not found."
  }
}

{
  "responseStatus": {
    "errorCode": "Conflict",
    "message": "Proposal state prevents editing"
  }
}

POST

public

proposals

{ProposalId}

items

{ProposalItemId}

note

Update Proposal Item Client Note

curl --request POST \
  --url https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/note \
  --header 'Accept: <accept>' \
  --header 'Content-Type: application/json' \
  --header 'X-MSS-API-APPID: <api-key>' \
  --header 'X-MSS-API-USERKEY: <api-key>' \
  --header 'X-MSS-CUSTOM-DATE: <api-key>' \
  --header 'X-MSS-SIGNATURE: <api-key>' \
  --data '
{
  "clientNote": "Mounted in the rack behind the display.",
  "setDefault": false,
  "updateAllInstances": false
}
'

import requests

url = "https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/note"

payload = {
    "clientNote": "Mounted in the rack behind the display.",
    "setDefault": False,
    "updateAllInstances": False
}
headers = {
    "Accept": "<accept>",
    "X-MSS-API-APPID": "<api-key>",
    "X-MSS-API-USERKEY": "<api-key>",
    "X-MSS-CUSTOM-DATE": "<api-key>",
    "X-MSS-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Accept: '<accept>',
    'X-MSS-API-APPID': '<api-key>',
    'X-MSS-API-USERKEY': '<api-key>',
    'X-MSS-CUSTOM-DATE': '<api-key>',
    'X-MSS-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    clientNote: 'Mounted in the rack behind the display.',
    setDefault: false,
    updateAllInstances: false
  })
};

fetch('https://sandbox.api.portal.io/public/proposals/{ProposalId}/items/{ProposalItemId}/note', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

[
  {
    "id": 81376,
    "parentId": 42344,
    "itemType": "Part",
    "referencedItemId": 63140,
    "createdDate": "2030-08-21T00:22:19Z",
    "lastModifiedDate": "2031-02-06T00:22:19Z",
    "brand": "Sonos",
    "model": "Amp",
    "name": "Installation Labor",
    "shortDescription": "Sonos Amp",
    "clientNote": "Mounted in the rack behind the display.",
    "imageUrl": "https://images.portal.io/catalog/sonos-amp.jpg",
    "msrp": 901.23,
    "sellPrice": 583.78,
    "cost": 759.6,
    "costUpdateDate": "2030-11-10T00:22:19Z",
    "supplier": "Sonos Inc.",
    "quantity": 9.6,
    "total": {
      "amount": 982.49,
      "currency": {
        "code": "USD",
        "symbol": "$"
      },
      "isCombinedPrice": false
    },
    "isTaxExempt": false,
    "isRecurringService": false,
    "linkedOrders": [
      {
        "orderId": 21802,
        "orderNumber": 182,
        "orderNumberSuffix": "A",
        "supplier": "Sonos Inc.",
        "supplierRef": "SN-10420",
        "orderName": "Living Room Sonos Amp",
        "orderStatus": "Submitted"
      }
    ]
  }
]

{
  "responseStatus": {
    "errorCode": "BadRequest",
    "message": "Malformed request body."
  }
}

{
  "responseStatus": {
    "errorCode": "Unauthorized",
    "message": "Not Authorized. Ensure a valid session cookie or HMAC authentication headers are provided."
  }
}

{
  "responseStatus": {
    "errorCode": "PaymentRequired",
    "message": "The dealer's subscription is inactive or expired. An active subscription is required to use this endpoint."
  }
}

{
  "responseStatus": {
    "errorCode": "Forbidden",
    "message": "You do not have permission for this action."
  }
}

{
  "responseStatus": {
    "errorCode": "NotFound",
    "message": "Proposal or item not found."
  }
}

{
  "responseStatus": {
    "errorCode": "Conflict",
    "message": "Proposal state prevents editing"
  }
}

Sets the client-facing note on a proposal item — the extra line under the item, for install detail or a caveat worth spelling out. Omitting ClientNote or sending null clears the note. For text the client should not see, use update area installer notes or the proposal’s internal notes instead. SetDefault saves the note as your own default for the catalog item, so items you add to later proposals start with it. It is saved for you alone, not for the whole company. Clearing the note with SetDefault set also clears that stored default. UpdateAllInstances applies the change to the proposal’s other items from the same source item that share its item type, in any area option.

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

enum<string>

required

Accept Header

Available options:

application/json

Path Parameters

ProposalId

integer<int32>

required

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

ProposalItemId

integer<int32>

required

Id of the proposal item to update.

Body

application/json

Proposals Service

clientNote

string

New client-facing note for the item. Omit it or send null to clear the note held on the item; with setDefault, the caller's stored default note is cleared as well.

setDefault

boolean

When true, also saves the note as the caller's own default note for the underlying catalog item, so items they add to later proposals start with it. Defaults to false.

updateAllInstances

boolean

When true, apply the change to every other instance of the same catalog item in this proposal that shares its item type, across all area options. Defaults to false.

Response

Success

integer<int32>

required

Unique numeric identifier of the proposal item

referencedItemId

integer<int32>

required

Identifier of the catalog, labor, custom, or fee item this proposal item was created from

createdDate

string<date-time>

required

UTC timestamp when the proposal item was created

quantity

number<double>

required

Quantity of the proposal item

parentId

integer<int32>

Identifier of the parent item when this item is nested under another item

itemType

enum<string>

Available options:

Part,

Labor,

CustomItem,

Fee

lastModifiedDate

string<date-time>

UTC timestamp when the proposal item was last modified

brand

string

Brand name of the item

model

string

Model value of the item

name

string

Name of a Labor item

shortDescription

string

Short description shown for the proposal item

clientNote

string

Client-facing note for the proposal item

imageUrl

string

Image URL of the item

msrp

number<double>

MSRP amount of the item

sellPrice

number<double>

Sell price for the proposal item

cost

number<double>

Supplier cost for the proposal item

costUpdateDate

string<date-time>

UTC timestamp when the supplier cost was last updated

supplier

string

Display name of the supplier assigned to the item.

total

PublicItemTotalModel · object

Total amount for a proposal item

Show child attributes

isTaxExempt

boolean

Whether the proposal item is tax exempt

isRecurringService

boolean

Whether the proposal item is a recurring service

linkedOrders

PublicLinkedOrderModel · object[]

Linked orders created from this proposal item

Show child attributes

⌘I

Authentication

Proposals

Proposal Items

Change Orders

AI Builder

People

Catalog

Users

Webhooks

Zapier Triggers

Update Proposal Item Client Note

Authorizations

Headers

Path Parameters

Body

Response