• 5.19 • 5.3 • 5.8

setNotes

Adds text notes to the interaction to be completed.

See the Embedded Agent Desktop Specification's Use Cases section for ways to use this method.

Request

Syntax

window.bpspat.api.setNotes(item_id, notes)

Parameters

Parameter	Type	Optional/Required	Description	Example
item_id	string	required	The interaction ID of the interaction	"EE55D97E-2705-49D1-A36D-34B3381DD416"
notes	string	required	Free-form text notes to be added to the completed interaction	"Repeat customer, third call today"

Response

Empty. In response to the request, the specified notes are added to the interaction upon completion.

< Previous | Next >