Function Index

A comprehensive alphabetical listing of all SSJS functions and objects documented in this reference.

A

Name	Category	Returns	Description
`Platform.Function.AddObjectArrayItem(obj, prop, val)`	Platform Functions	void	Append item to a SOAP API object array property
`Attribute.Value(name)`	Global Object	string	Read subscriber attribute in email context

B

Name	Category	Returns	Description
`Platform.Function.Base64Decode(value)`	Platform Functions	string	Decode Base64 string
`Platform.Function.Base64Encode(value)`	Platform Functions	string	Encode string to Base64
`Platform.Function.BeginImpressionRegion(name)`	Platform Functions	void	Start a named impression region

C

Name	Category	Returns	Description
`Platform.Function.Char(ascii)`	Platform Functions	string	Get character from ASCII code
`Platform.Function.CloudPagesURL(pageId, ...)`	Platform Functions	string	Generate encrypted CloudPages URL
`Platform.Function.Concat(...values)`	Platform Functions	string	Concatenate strings
`ContentAreaByKey(key)`	Global Functions	string	Render classic content area
`ContentBlockByID(id)`	Global Functions	string	Render Content Builder block by ID
`ContentBlockByKey(key)`	Global Functions	string	Render Content Builder block by key
`ContentBlockByName(path)`	Global Functions	string	Render Content Builder block by name
`Platform.Function.ContentImageByID(id[, fallback])`	Platform Functions	string	img tag for Content Builder image by ID
`Platform.Function.ContentImageByKey(key[, fallback])`	Platform Functions	string	img tag for Content Builder image by key
`Platform.Function.CreateObject(type)`	Platform Functions	object	Create SOAP API object (legacy)

D

Name	Category	Returns	Description
`Platform.Function.DataExtensionRowCount(de)`	Platform Functions	number	Count rows in a DE
`Platform.Function.DateAdd(date, n, unit)`	Platform Functions	date	Add time to a date
`Platform.Function.DateDiff(d1, d2, unit)`	Platform Functions	number	Calculate date difference
`Platform.Function.DateParse(str, fmt)`	Platform Functions	date	Parse date string
`DataExtension.Init(key)`	Core Library	DataExtension	Initialize DE object
`de.Rows.Add(obj)`	Core Library	number	Insert DE row
`de.Rows.Remove(col, val)`	Core Library	number	Delete DE rows
`de.Rows.Retrieve([filter])`	Core Library	object[]	Read DE rows
`de.Rows.Update(vals, keys, keyVals)`	Core Library	number	Update DE rows
`Platform.Function.DecryptAsymmetric(val, key)`	Platform Functions	string	Decrypt with private key
`Platform.Function.DecryptSymmetric(val, alg, ...)`	Platform Functions	string	Decrypt symmetric cipher
`Platform.Function.DeleteData(de, keys, vals)`	Platform Functions	number	Delete DE rows
`DeleteDE(...)`	Platform Functions	number	Alias for DeleteData

E

Name	Category	Returns	Description
`Email.Init(emailId)`	Core Library	Email	Initialize email object
`email.Send(sub, opts)`	Core Library	number	Send email
`Platform.Function.Empty(val)`	Platform Functions	boolean	Check null/empty/whitespace
`Platform.Function.EncryptAsymmetric(val, key)`	Platform Functions	string	Encrypt with public key
`Platform.Function.EncryptSymmetric(val, alg, ...)`	Platform Functions	string	Encrypt with symmetric cipher
`Platform.Function.EndImpressionRegion([closeAll])`	Platform Functions	void	End an impression region
`Error(message)`	Global Functions	Error	Create Error object
`Platform.Function.ExecuteFilter(name)`	Platform Functions	object[]	Execute saved DE filter

F

Name	Category	Returns	Description
`Platform.Function.Format(val, fmt)`	Platform Functions	string	Format number/string (.NET style)
`Platform.Function.FormatDate(date, fmt, locale)`	Platform Functions	string	Format a date value

G

Name	Category	Returns	Description
`Platform.Function.GUID()`	Platform Functions	string	Generate UUID v4

H

Name	Category	Returns	Description
`HTTP.Get(url)`	Core HTTP	string	Simple HTTP GET
`HTTP.GetRequest(url, statusCode, ...)`	Core HTTP	string	HTTP GET with status code
`Platform.Function.HTTPGet(url, ...)`	Platform Functions	string	HTTP GET (no Core required)
`Platform.Function.HTTPPost(url, ct, body, ...)`	Platform Functions	string	HTTP POST (no Core required)
`HTTP.Post(url, ct, body, ...)`	Core HTTP	string	Simple HTTP POST
`HTTP.PostRequest(url, ct, body, sc, ...)`	Core HTTP	string	HTTP POST with status code
`Platform.Function.HMAC(alg, secret, msg)`	Platform Functions	string	Compute HMAC signature

I

Name	Category	Returns	Description
`Platform.Function.IIf(cond, t, f)`	Platform Functions	any	Inline conditional (ternary)
`Platform.Function.IndexOf(val, sub)`	Platform Functions	number	Find substring position
`Platform.Function.InsertData(de, cols, vals)`	Platform Functions	number	Insert DE row
`InsertDE(...)`	Platform Functions	number	Alias for InsertData
`Platform.Function.InvokeConfigure(obj, action, ...)`	Platform Functions	string	SOAP Configure call (legacy)
`Platform.Function.InvokeCreate(obj, ...)`	Platform Functions	object	SOAP Create (legacy)
`Platform.Function.InvokeDelete(obj, ...)`	Platform Functions	object	SOAP Delete (legacy)
`Platform.Function.InvokeExecute(obj, method, ...)`	Platform Functions	string	SOAP Execute call (legacy)
`Platform.Function.InvokeExtract(obj, statusArr, ...)`	Platform Functions	string	SOAP Extract call (legacy)
`Platform.Function.InvokePerform(obj, action, ...)`	Platform Functions	string	SOAP Perform action (legacy)
`Platform.Function.InvokeRetrieve(obj)`	Platform Functions	object[]	SOAP Retrieve (legacy)
`Platform.Function.InvokeSchedule(obj, action, sched, ...)`	Platform Functions	string	SOAP Schedule call (legacy)
`Platform.Function.InvokeUpdate(obj, ...)`	Platform Functions	object	SOAP Update (legacy)
`Platform.Function.IsEmailAddress(val)`	Platform Functions	boolean	Validate email format
`Platform.Function.IsPhoneNumber(val)`	Platform Functions	boolean	Validate phone number format
`Platform.Function.IsNull(val)`	Platform Functions	boolean	Check for null

L

Name	Category	Returns	Description
`Platform.Function.Length(val)`	Platform Functions	number	Get string length
`List.Init(key)`	Core Library	List	Initialize list object
`list.Subscribers.Add(email, attrs)`	Core Library	void	Add subscriber to list
`list.Subscribers.Remove(email)`	Core Library	void	Remove subscriber from list
`Platform.Function.LogDataExtension(de, cols, vals)`	Platform Functions	void	Log entry to DE
`Platform.Function.Lookup(de, col, keyCol, keyVal)`	Platform Functions	string	Single-value DE lookup
`Platform.Function.LookupOrderedRows(de, count, sort, ...)`	Platform Functions	object[]	Sorted/limited DE rows
`Platform.Function.LookupRows(de, col, val)`	Platform Functions	object[]	Multiple DE rows
`Platform.Function.Lowercase(val)`	Platform Functions	string	Convert to lowercase

M

Name	Category	Returns	Description
`Platform.Function.MD5(val)`	Platform Functions	string	MD5 hash

N

Name	Category	Returns	Description
`Platform.Function.Now()`	Platform Functions	date	Current SFMC server date/time

P

Name	Category	Returns	Description
`Platform.Function.ParseJSON(str)`	Platform Functions	object	Parse JSON string to object
`Platform.ClientBrowser.Name`	Platform Object	string	Browser name
`Platform.Load(lib, version)`	Platform Object	void	Load Core library
`Platform.Request.GetCookieValue(name)`	Platform Object	string	Read cookie
`Platform.Request.GetFormField(name)`	Platform Object	string	Read form field
`Platform.Request.GetPostData([encoding])`	Platform Object	string	Read raw POST body
`Platform.Request.GetQueryStringParameter(name)`	Platform Object	string	Read URL query param
`Platform.Request.GetRequestHeader(name)`	Platform Object	string	Read request header
`Platform.Request.GetUserLanguages()`	Platform Object	string	Read Accept-Language header
`Platform.Request.Method`	Platform Object	string	HTTP method (GET/POST)
`Platform.Response.Redirect(url)`	Platform Object	void	Redirect browser
`Platform.Response.SetContentType(mime)`	Platform Object	void	Set Content-Type
`Platform.Response.SetCookie(name, val, ...)`	Platform Object	void	Set response cookie
`Platform.Response.SetResponseCode(code)`	Platform Object	void	Set HTTP status code
`Platform.Variable.GetValue(name)`	Platform Object	string	Read AMPscript variable
`Platform.Variable.SetValue(name, val)`	Platform Object	void	Write AMPscript variable
`Platform.Function.ProperCase(val)`	Platform Functions	string	Title case a string
`proxy.create(type, props)`	WSProxy	object	SOAP Create
`proxy.createBatch(type, arr)`	WSProxy	object	SOAP batch Create
`proxy.delete(type, props)`	WSProxy	object	SOAP Delete
`proxy.describe(objectType)`	WSProxy	object	Return SOAP object metadata
`proxy.execute(type, props)`	WSProxy	object	SOAP Execute
`proxy.getNextBatch(type, requestId)`	WSProxy	object	Next page after retrieve
`proxy.perform(type, action, props)`	WSProxy	object	SOAP Perform
`proxy.resetClientIds()`	WSProxy	void	Clear BU context from setClientId
`proxy.retrieve(type, cols, filter)`	WSProxy	object	SOAP Retrieve
`proxy.retrieveBatch(type, cols, filter)`	WSProxy	object	SOAP Retrieve (paginated)
`proxy.setClientId(clientId)`	WSProxy	void	Set BU context
`proxy.update(type, props, opts)`	WSProxy	object	SOAP Update
`proxy.updateBatch(type, arr, opts)`	WSProxy	object	SOAP batch Update

R

Name	Category	Returns	Description
`Platform.Function.RaiseError(msg, skip)`	Platform Functions	void	Halt execution with error
`Platform.Function.Replace(val, search, rep)`	Platform Functions	string	Replace all occurrences

S

Name	Category	Returns	Description
`Script.Util.HttpRequest`	HTTP	HttpRequest	Full HTTP request object
`new Script.Util.WSProxy()`	WSProxy	WSProxy	Create WSProxy instance
`Platform.Function.SetObjectProperty(obj, name, val)`	Platform Functions	void	Set SOAP object property (legacy)
`Platform.Function.SHA256(val)`	Platform Functions	string	SHA-256 hash
`String(val)`	Global Functions	string	Convert CLR string to JS string
`Stringify(obj)`	Global Functions	string	Object to JSON string
`sub.Attributes.Add(name, val)`	Core Library	void	Add subscriber attribute
`sub.Attributes.Remove(name)`	Core Library	void	Remove subscriber attribute
`sub.Lists.Add(listKey)`	Core Library	void	Add subscriber to list
`sub.Lists.Remove(listKey)`	Core Library	void	Remove subscriber from list
`Subscriber.Init(key)`	Core Library	Subscriber	Initialize subscriber object
`Platform.Function.Substring(val, start, len)`	Platform Functions	string	Extract substring (1-based)
`Platform.Function.SystemDateToLocalDate(date)`	Platform Functions	date	Server to local timezone

T

Name	Category	Returns	Description
`TreatAsContent(str)`	Global Functions	void	Evaluate AMPscript in string
`TreatAsContentArea(str)`	Global Functions	void	Evaluate classic content
`Platform.Function.Trim(val)`	Platform Functions	string	Trim whitespace
`TriggeredSend.Init(key)`	Core Library	TriggeredSend	Initialize TS object
`ts.Send(subscriber)`	Core Library	number	Send triggered email
`Platform.Function.TriggeredSend(key, email, subKey, attrs)`	Platform Functions	void	Fire a triggered send

U

Name	Category	Returns	Description
`Platform.Function.UpdateData(de, cols, vals, keys, keyVals)`	Platform Functions	number	Update DE rows
`UpdateDE(...)`	Platform Functions	number	Alias for UpdateData
`Platform.Function.Uppercase(val)`	Platform Functions	string	Convert to uppercase
`Platform.Function.URLEncode(val)`	Platform Functions	string	URL-encode a string
`Platform.Function.UpsertData(de, keys, keyVals, cols, vals)`	Platform Functions	number	Insert or update DE row
`UpsertDE(...)`	Platform Functions	number	Alias for UpsertData

V

Name	Category	Returns	Description
`Variable.GetValue(name)`	Global Object	string	Read AMPscript variable (alias)
`Variable.SetValue(name, val)`	Global Object	void	Write AMPscript variable (alias)

W

Name	Category	Returns	Description
`Write(value)`	Global Functions	void	Output to page