24/7 Support: 800.608.6482

Navigation


QuoteNote_Update_Public

This function changes the public status of a note. Public indicates a note can be seen by the customer in their account.

Quote may be specified using one of Quote_ID, Edit_Quote, or Quote_Code. Only one indentifier is needed.

Request Parameters

store_code Type:
String
Title:
Store Code
Store code to run the function against. Found in the Miva Admin under Settings > Store Details
function Type:
String
Title:
Module
For module level functions this parameter will always have the value "Module"
module_code Type:
String
Title:
Quote
The module code will always have the value "quote" for this function
module_function Type:
String
Title:
Module_Function
Specifies the function being executed, in this case "QuoteNote_Update_Public"
quote_id Type:
Number
Title:
Quote Id
The id number of the quote
note_id Type:
Number
Title:
Note ID
The id number of the note
public Type:
Boolean
Title:
Public
Boolean value setting the note public status to on (true) or off (false)

Response Parameters

success Type:
Boolean
Title:
Status Response
Boolean value indicating if the api request was successful

Example Request

Example Response

Error Responses

error code:
MER-UTL-QUOTES-00348
error message:
Note not found
description:
Note not found
error code:
MER-UTL-QUOTES-00346
error message:
Unable to load quote: One of Quote_ID, Edit_Quote, or Quote_Code must be specified
description:
Unable to load quote

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.