Skip to content

`QuoteNote_Update_Public`#

Description#

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

Request Parameters#

Parameter	Type	Description
`function`	String	For module level functions this parameter will always have the value `Module`
`module_code`	String	The module code will always have the value `quote` for this function
`module_function`	String	Specifies the function being executed, in this case `QuoteNote_Update_Public`
`quote_id` `edit_quote` `quote_code`	Number String String	The id of the quote The code of the quote The code of the quote
`note_id`	Number	The id number of the note
`public`	Boolean	Boolean value setting the note public status to on (true) or off (false)

Response Parameters#

Parameter	Type	Description
`success`	Boolean	Boolean value indicating if the API request was successful

Example Request#

{
    "Store_Code": "{{Store_Code}}",
    "Miva_Request_Timestamp": "{{$timestamp}}",
    "Function": "Module",
    "Module_Code": "quote",
    "Module_Function": "QuoteNote_Update_Public",
    "Quote_ID": 1008,
    "Note_ID": 6,
    "Public": true
}

Example Response#

{
    "success": 1
}

Error Responses#

Error Code	Error Message	Error Description
MER-UTL-QUOTES-00348	Note not found	Note not found
MER-UTL-QUOTES-00346	Unable to load quote: One of Quote_ID, Edit_Quote, or Quote_Code must be specified	Unable to load quote