Conventions used
There are a number of text conventions used throughout this book.
Code in text
: Indicates code words in text, database table names, folder names, filenames, file extensions, pathnames, dummy URLs, user input, and Twitter handles. Here is an example: "PUT
sends across an encrypted payload to interact with the target for overwrite update, but if that object does not exist, then PUT
may create it instead."
A block of code is set as follows:
<script runat="server"> Platform.Load("Core","1.1.1") var url = https://{{et_subdomain}}.rest.marketingcloudapis.com/email/v1/rest var req = new Script.Util.HttpGet(url); var resp = req.send();</script>
When we wish to draw your attention to a particular part of a code block, the relevant lines or items are set in bold:
<script runat="server"> Platform.Load("Core","1.1.1") var url = https://{{et_subdomain}}.rest.marketingcloudapis.com/email/v1/rest var req = new Script.Util.HttpGet(url); var resp = req.send();</script>
Any command-line input or output is written as follows:
<script runat=server> Platform.Load("Core","1.1.1"); var prox = new Script.Util.WSProxy(); var name = "My Automation"; var request = prox.retrieve("Automation", ["ProgramID"], { Property: "Name", SimpleOperator: "equals", Value: name }); var objId = request.Results[0].ObjectID; </script>
Bold: Indicates a new term, an important word, or words that you see onscreen. For instance, words in menus or dialog boxes appear in bold. Here is an example: "To do this, navigate to the User Settings menu and select Developer Settings."
Tips or Important Notes
Appear like this.