Function Index
Complete A–Z index of SSJS functions, methods, and objects documented in this reference — global functions, Platform.Function, Core library, WSProxy, HTTP, and Platform objects.
Alphabetical listing of APIs covered in this guide. Instance-style Core and WSProxy calls use placeholders such as <WSProxyInstance> for the variable you initialized (for example from new Script.Util.WSProxy()). That name is documentation shorthand — it is not a literal prefix like proxy. that you must type.
For category browsing, see Platform Functions, Global Functions, WSProxy, HTTP, and Core Library.
A
| Name | Category | Returns | Description |
|---|---|---|---|
Platform.Function.AddObjectArrayItem(apiObject, propertyName, value) |
Platform Functions | void | Append item to a SOAP API object array property |
Attribute.GetValue(name) |
Global Object | string | Profile attribute in email / triggered send context |
Account.Init(key) |
Core Library | AccountInstance | Initialize Account |
Account.Retrieve(filter) |
Core Library | object[] | Retrieve accounts |
Account.Tracking.Retrieve(filter) |
Core Library | object[] | Account-level tracking |
<AccountInstance>.Update(properties) |
Core Library | string | Update account |
AccountUser.Init(targetUserKey, myClientID) |
Core Library | AccountUserInstance | Initialize AccountUser |
AccountUser.Add(properties) |
Core Library | string | Create AccountUser |
AccountUser.Retrieve(filter) |
Core Library | object[] | Retrieve AccountUsers |
<AccountUserInstance>.Update(properties) |
Core Library | string | Update AccountUser |
<AccountUserInstance>.Activate() |
Core Library | string | Activate AccountUser |
<AccountUserInstance>.Deactivate() |
Core Library | string | Deactivate AccountUser |
<ArrayInstance>.concat(value[, ...]) |
ECMAScript Builtins | array | Merge arrays |
<ArrayInstance>.join([separator]) |
ECMAScript Builtins | string | Join elements to string |
<ArrayInstance>.length |
ECMAScript Builtins | number | Number of elements |
<ArrayInstance>.pop() |
ECMAScript Builtins | any | Remove and return last element |
<ArrayInstance>.push(element[, ...]) |
ECMAScript Builtins | number | Add elements to end; return new length |
<ArrayInstance>.reverse() |
ECMAScript Builtins | array | Reverse array in place |
<ArrayInstance>.shift() |
ECMAScript Builtins | any | Remove and return first element |
<ArrayInstance>.slice([start[, end]]) |
ECMAScript Builtins | array | Shallow copy of a portion |
<ArrayInstance>.sort([compareFn]) |
ECMAScript Builtins | array | Sort in place |
<ArrayInstance>.splice(start[, deleteCount[, item1[, ...]]]) |
ECMAScript Builtins | array | ⚠️ Broken in SFMC SSJS — see polyfills |
<ArrayInstance>.unshift(element[, ...]) |
ECMAScript Builtins | number | Add elements to start; return new length |
B
| Name | Category | Returns | Description |
|---|---|---|---|
Base64Decode(encodedString) |
Global Functions | string | Decode Base64 string to plain text (requires Platform.Load) |
Platform.Function.Base64Decode(encodedString[, charset]) |
Platform Functions | string | Decode a Base64-encoded string |
Base64Encode(string) |
Global Functions | string | Encode plain text to Base64 (requires Platform.Load) |
Platform.Function.Base64Encode(string[, charset]) |
Platform Functions | string | Encode a string to Base64 |
Platform.Function.BeginImpressionRegion(name) |
Platform Functions | void | Start a named impression region |
BounceEvent.Retrieve(filter) |
Core Library | object[] | Bounce tracking events |
C
| Name | Category | Returns | Description |
|---|---|---|---|
ContentArea(id[, regionName, errorMsg, fallbackContent]) |
Global Functions | string | Classic Content Area by ID — deprecated, requires Platform.Load |
ContentAreaByName(name[, regionName, errorMsg, fallbackContent]) |
Global Functions | string | Classic Content Area by name — deprecated, requires Platform.Load |
Platform.Function.ContentArea(id[, regionName, stopOnError, fallbackContent]) |
Platform Functions | string | Classic Content Area by ID — deprecated |
Platform.Function.ContentAreaByName(name[, regionName, stopOnError, fallbackContent]) |
Platform Functions | string | Classic Content Area by name — deprecated |
Platform.Function.ContentBlockByID(id[, regionName, stopOnError, fallbackContent]) |
Platform Functions | string | Render Content Builder block by ID |
Platform.Function.ContentBlockByKey(customerKey[, regionName, stopOnError, fallbackContent]) |
Platform Functions | string | Render Content Builder block by key |
Platform.Function.ContentBlockByName(name[, regionName, stopOnError, fallbackContent, statusVariable]) |
Platform Functions | string | Render Content Builder block by name |
Platform.Function.ContentImageByID(id[, fallbackId]) |
Platform Functions | string | img tag for Content Builder image by ID |
Platform.Function.ContentImageByKey(key[, fallbackId]) |
Platform Functions | string | img tag for Content Builder image by key |
Platform.Function.CreateObject(objectType) |
Platform Functions | object | Create SOAP API object (legacy) |
ClickEvent.Retrieve(filter) |
Core Library | object[] | Click tracking events |
ContentAreaObj.Init(key) |
Core Library | ContentAreaObjInstance | Classic Content Area object (deprecated) |
ContentAreaObj.Add(properties) |
Core Library | string | Create Content Area (deprecated) |
ContentAreaObj.Retrieve(filter) |
Core Library | object[] | Retrieve Content Areas (deprecated) |
<ContentAreaObjInstance>.Update(properties) |
Core Library | string | Update Content Area (deprecated) |
<ContentAreaObjInstance>.Remove() |
Core Library | string | Remove Content Area (deprecated) |
D
| Name | Category | Returns | Description |
|---|---|---|---|
DateTime.TimeZone.Retrieve(filter) |
Platform Object | object[] | Time zone definitions (requires Core load) |
DataExtension.Init(key) |
Core Library | DataExtensionInstance | Initialize DE object |
DataExtension.Add(properties) |
Core Library | DataExtensionInstance | Create data extension |
DataExtension.Retrieve(filter, [queryAllAccounts]) |
Core Library | object[] | Retrieve data extensions |
<DataExtensionInstance>.Fields.Add(properties) |
Core Library | string | Add field to DE |
<DataExtensionInstance>.Fields.Retrieve() |
Core Library | object[] | Retrieve DE field definitions |
<DataExtensionInstance>.Fields.UpdateSendableField(deFieldName, subscriberField) |
Core Library | string | Update sendable field mapping |
<DataExtensionInstance>.Rows.Add(rowData) |
Core Library | string | Insert DE row(s) |
<DataExtensionInstance>.Rows.Lookup(searchFieldNames, searchValues, [limit], [orderByFieldName]) |
Core Library | object[] | Lookup DE rows |
<DataExtensionInstance>.Rows.Remove(columnNames, columnValues) |
Core Library | number | Delete matching DE rows |
<DataExtensionInstance>.Rows.Retrieve([filter]) |
Core Library | object[] | Read DE rows |
<DataExtensionInstance>.Rows.Update(rowData, whereFieldNames, whereValues) |
Core Library | string | Update DE rows |
DeliveryProfile.Init(key) |
Core Library | DeliveryProfileInstance | Initialize DeliveryProfile |
DeliveryProfile.Add(properties) |
Core Library | string | Create DeliveryProfile |
<DeliveryProfileInstance>.Update(properties) |
Core Library | string | Update DeliveryProfile |
<DeliveryProfileInstance>.Remove() |
Core Library | string | Remove DeliveryProfile |
Platform.Function.DeleteData(deName, whereFieldNames, whereFieldValues) |
Platform Functions | number | Delete DE rows |
DeleteDE(deName, whereFieldNames, whereFieldValues) |
Platform Functions | number | Alias for DeleteData |
E
| Name | Category | Returns | Description |
|---|---|---|---|
Email.Init(key) |
Core Library | EmailInstance | Initialize email definition |
Email.Add(properties) |
Core Library | EmailInstance | Create email definition |
Email.Retrieve(filter) |
Core Library | object[] | Retrieve email definitions |
<EmailInstance>.Update(properties) |
Core Library | string | Update email definition |
<EmailInstance>.Remove() |
Core Library | string | Remove email definition |
<EmailInstance>.Validate() |
Core Library | object | Validate email |
<EmailInstance>.CheckContent() |
Core Library | object | Content checks |
Platform.Function.EndImpressionRegion([closeAll]) |
Platform Functions | void | End an impression region |
Error(message) |
Global Functions | Error | Create Error object (new Error([message])) |
ErrorUtil.ThrowWSProxyError(result) |
Platform Object | void | Throw when WSProxy status indicates failure |
F
| Name | Category | Returns | Description |
|---|---|---|---|
FilterDefinition.Init(key) |
Core Library | FilterDefinitionInstance | Initialize filter definition |
FilterDefinition.Add(properties) |
Core Library | string | Create filter definition |
FilterDefinition.Retrieve(filter) |
Core Library | object[] | Retrieve filter definitions |
<FilterDefinitionInstance>.Update(properties) |
Core Library | string | Update filter definition |
<FilterDefinitionInstance>.Remove() |
Core Library | string | Remove filter definition |
Folder.Init([key]) |
Core Library | FolderInstance | Initialize Folder |
Folder.Add(properties) |
Core Library | string | Create folder |
Folder.Retrieve(filter) |
Core Library | object[] | Retrieve folders |
<FolderInstance>.Update(properties) |
Core Library | string | Update folder |
<FolderInstance>.Remove() |
Core Library | string | Remove folder |
<FolderInstance>.SetID(id) |
Core Library | void | Set folder ID |
Format(textToFormat, formatCode) |
Global Functions | string | Format a date/number string |
ForwardedEmailEvent.Retrieve(filter) |
Core Library | object[] | Forwarded-email events |
ForwardedEmailOptInEvent.Retrieve(filter) |
Core Library | object[] | Forwarded opt-in events |
G
| Name | Category | Returns | Description |
|---|---|---|---|
Platform.Function.GUID() |
Platform Functions | string | Generate UUID v4 |
Platform.Recipient.GetAttributeValue(attributeName) |
Platform Functions | string | Returns the value of a subscriber attribute or sendable DE field for the current recipient |
Platform.Request.GetCookieValue(name) |
Platform Functions | string | Read a cookie value |
Platform.Request.GetFormField(name) |
Platform Functions | string | Read a form field (POST or GET) |
Platform.Request.GetPostData([encoding]) |
Platform Functions | string | Read raw POST body (optional character encoding) |
Platform.Request.GetQueryStringParameter(name) |
Platform Functions | string | Read a URL query parameter |
Platform.Request.GetRequestHeader(name) |
Platform Functions | string | Read a request header |
Platform.Request.GetUserLanguages() |
Platform Functions | string | Read the browser Accept-Language header value |
H
| Name | Category | Returns | Description |
|---|---|---|---|
HTTP.Get(url[, headerNames, headerValues]) |
Core HTTP | object | HTTP GET — structured status + body |
HTTP.Post(url, contentType, payload, headerNames, headerValues) |
Core HTTP | object | HTTP POST — structured status + body |
HTTPHeader.GetValue(name) |
Platform Object | string | Read HTTP request header (Core load) |
HTTPHeader.SetValue(name, value) |
Platform Object | void | Set HTTP request header (Core load) |
HTTPHeader.Remove(headerName) |
Platform Object | string | Remove HTTP request header (Core load) |
Platform.Function.HTTPGet(url, continueOnError[, emptyContentHandling, headerNames, headerValues, statusVariable]) |
Platform Functions | string | HTTP GET — body string only |
Platform.Function.HTTPPost(url, contentType, payload[, headerNames, headerValues, response]) |
Platform Functions | string | HTTP POST — body string only |
I
| Name | Category | Returns | Description |
|---|---|---|---|
Platform.Function.InsertData(deName, fieldNames, fieldValues) |
Platform Functions | number | Insert DE row |
InsertDE(deName, fieldNames, fieldValues) |
Platform Functions | number | Alias for InsertData |
Platform.Function.InvokeConfigure(apiObject, method, status, options) |
Platform Functions | string | SOAP Configure call (legacy) |
Platform.Function.InvokeCreate(apiObject, status, options) |
Platform Functions | object | SOAP Create (legacy) |
Platform.Function.InvokeDelete(apiObject, status, options) |
Platform Functions | object | SOAP Delete (legacy) |
Platform.Function.InvokeExecute(apiObject, status, options) |
Platform Functions | string | SOAP Execute call (legacy) |
Platform.Function.InvokeExtract(apiObject, statusArray[, options]) |
Platform Functions | string | SOAP Extract call (legacy) |
Platform.Function.InvokePerform(apiObject, method, status, options) |
Platform Functions | string | SOAP Perform action (legacy) |
Platform.Function.InvokeRetrieve(apiObject, status) |
Platform Functions | object[] | SOAP Retrieve (legacy) |
Platform.Function.InvokeSchedule(apiObject, action, schedule[, statusArray, options]) |
Platform Functions | string | SOAP Schedule call (legacy) |
Platform.Function.InvokeUpdate(apiObject, status, options) |
Platform Functions | string | SOAP Update (legacy) |
Platform.Function.IsEmailAddress(value) |
Platform Functions | boolean | Validate email format |
Platform.Function.IsPhoneNumber(value) |
Platform Functions | boolean | Validate phone number format |
Platform.Function.IsCHTMLBrowser(userAgentString) |
Platform Functions | boolean | Detect CHTML / feature-phone browsers |
isFinite(value) |
ECMAScript Builtins | boolean | Test if value is finite |
isNaN(value) |
ECMAScript Builtins | boolean | Test if value is NaN |
L
M
| Name | Category | Returns | Description |
|---|---|---|---|
Math.abs(x) |
ECMAScript Builtins | number | Absolute value |
Math.acos(x) |
ECMAScript Builtins | number | Arccosine |
Math.asin(x) |
ECMAScript Builtins | number | Arcsine |
Math.atan(x) |
ECMAScript Builtins | number | Arctangent |
Math.atan2(y, x) |
ECMAScript Builtins | number | Arctangent of quotient |
Math.ceil(x) |
ECMAScript Builtins | number | Round up |
Math.cos(x) |
ECMAScript Builtins | number | Cosine |
Math.E |
ECMAScript Builtins | number | Euler’s number (~2.718) |
Math.exp(x) |
ECMAScript Builtins | number | e to the power of x |
Math.floor(x) |
ECMAScript Builtins | number | Round down |
Math.LN2 |
ECMAScript Builtins | number | Natural logarithm of 2 |
Math.LN10 |
ECMAScript Builtins | number | Natural logarithm of 10 |
Math.log(x) |
ECMAScript Builtins | number | Natural logarithm |
Math.LOG10E |
ECMAScript Builtins | number | Base-10 log of e |
Math.LOG2E |
ECMAScript Builtins | number | Base-2 log of e |
Math.max(value1[, value2, ...]) |
ECMAScript Builtins | number | Largest value |
Math.min(value1[, value2, ...]) |
ECMAScript Builtins | number | Smallest value |
Math.PI |
ECMAScript Builtins | number | Pi (~3.14159) |
Math.pow(base, exponent) |
ECMAScript Builtins | number | Base to the power of exponent |
Math.random() |
ECMAScript Builtins | number | Random number [0, 1) |
Math.round(x) |
ECMAScript Builtins | number | Round to nearest integer |
Math.sin(x) |
ECMAScript Builtins | number | Sine |
Math.sqrt(x) |
ECMAScript Builtins | number | Square root |
Math.SQRT1_2 |
ECMAScript Builtins | number | Square root of 1/2 |
Math.SQRT2 |
ECMAScript Builtins | number | Square root of 2 |
Math.tan(x) |
ECMAScript Builtins | number | Tangent |
Platform.Function.MD5(string[, charset]) |
Platform Functions | string | MD5 hash of a string |
N
| Name | Category | Returns | Description |
|---|---|---|---|
NotSentEvent.Retrieve(filter) |
Core Library | object[] | Not-sent events |
Number.toExponential([fractionDigits]) |
ECMAScript Builtins | string | Exponential notation string |
Number.toFixed([fractionDigits]) |
ECMAScript Builtins | string | Fixed-point notation string |
Number.toPrecision([precision]) |
ECMAScript Builtins | string | Precision notation string |
Platform.Function.Now([useContextTime]) |
Platform Functions | string | Current SFMC server date/time |
O
| Name | Category | Returns | Description |
|---|---|---|---|
Object.hasOwnProperty(v) |
ECMAScript Builtins | boolean | Test if object has own property |
OpenEvent.Retrieve(filter) |
Core Library | object[] | Open tracking events |
P
| Name | Category | Returns | Description |
|---|---|---|---|
parseFloat(string) |
ECMAScript Builtins | number | Parse float from string |
parseInt(string[, radix]) |
ECMAScript Builtins | number | Parse integer from string |
Platform.Function.ParseJSON(jsonString) |
Platform Functions | object | Parse JSON string to object |
Platform.Load(libraryName, version) |
Platform Object | void | Load Core library |
Platform.Request.* |
Platform Object | various | HTTP request (query, POST, headers, cookies) |
Platform.Response.* |
Platform Object | various | HTTP response (redirect, cookies, content type) |
Platform.Variable.* |
Platform Object | various | AMPscript variable bridge |
Platform.Recipient.* |
Platform Object | various | Current-recipient attributes |
Portfolio.Init(key) |
Core Library | PortfolioInstance | Initialize Portfolio |
Portfolio.Add(properties) |
Core Library | string | Create portfolio asset |
Portfolio.Retrieve(filter) |
Core Library | object[] | Retrieve portfolio assets |
<PortfolioInstance>.Update(properties) |
Core Library | string | Update portfolio asset |
<PortfolioInstance>.Remove() |
Core Library | string | Remove portfolio asset |
<WSProxyInstance>.createItem(objectType, properties) |
WSProxy | object | SOAP Create |
<WSProxyInstance>.updateItem(objectType, properties) |
WSProxy | object | SOAP Update |
<WSProxyInstance>.deleteItem(objectType, properties) |
WSProxy | object | SOAP Delete |
<WSProxyInstance>.createBatch(objectType, propertiesArray) |
WSProxy | object | SOAP batch Create |
<WSProxyInstance>.updateBatch(objectType, propertiesArray) |
WSProxy | object | SOAP batch Update |
<WSProxyInstance>.deleteBatch(objectType, propertiesArray) |
WSProxy | object | SOAP batch Delete |
<WSProxyInstance>.describe(objectType) |
WSProxy | object | SOAP object metadata |
<WSProxyInstance>.execute(objectType, requestName) |
WSProxy | object | SOAP Execute |
<WSProxyInstance>.getNextBatch(objectType, requestId) |
WSProxy | object | Next retrieve page |
<WSProxyInstance>.performItem(objectType, properties, action[, performOptions]) |
WSProxy | object | SOAP Perform (single) |
<WSProxyInstance>.performBatch(objectType, propertiesArray, action[, performOptions]) |
WSProxy | object | SOAP Perform (batch) |
<WSProxyInstance>.resetClientIds() |
WSProxy | void | Clear BU override |
<WSProxyInstance>.retrieve(objectType, columns[, filter[, retrieveOptions[, requestProps]]]) |
WSProxy | object | SOAP Retrieve |
<WSProxyInstance>.setBatchSize(batchSize) |
WSProxy | void | Retrieve page size |
<WSProxyInstance>.setClientId(clientId) |
WSProxy | void | Target another BU |
Q
| Name | Category | Returns | Description |
|---|---|---|---|
QueryDefinition.Init(key) |
Core Library | QueryDefinitionInstance | Initialize query activity |
QueryDefinition.Add(properties) |
Core Library | string | Create query activity |
QueryDefinition.Retrieve(filter) |
Core Library | object[] | Retrieve query activities |
<QueryDefinitionInstance>.Update(properties) |
Core Library | string | Update query activity |
<QueryDefinitionInstance>.Remove() |
Core Library | string | Remove query activity |
<QueryDefinitionInstance>.Perform(action) |
Core Library | string | Run / manage query |
R
| Name | Category | Returns | Description |
|---|---|---|---|
Platform.Function.RaiseError(message[, currentRecipientOnly[, errorCode[, errorNumber]]]) |
Platform Functions | void | Halt execution with error |
Platform.Function.RedirectTo(url) |
Platform Functions | void | Email href redirect helper |
Platform.Response.Redirect(url, movedPermanently) |
Platform Response | void | Redirect the browser |
Platform.Response.RemoveCookie(name) |
Platform Response | void | Remove a cookie |
Platform.Response.RemoveResponseHeader(headerName) |
Platform Response | void | Remove a response header |
S
| Name | Category | Returns | Description |
|---|---|---|---|
new Script.Util.HttpRequest(url) |
HTTP | HttpRequestInstance | Full HTTP request object |
new Script.Util.HttpGet(url) |
HTTP | HttpRequestInstance | HTTP GET shorthand |
<HttpRequestInstance>.send() |
HTTP | object | Execute HTTP request |
<HttpRequestInstance>.setHeader(name, value) |
HTTP | void | Set request header |
<HttpRequestInstance>.clearHeaders() |
HTTP | void | Clear all custom headers |
<HttpRequestInstance>.removeHeader(name) |
HTTP | void | Remove one header |
new Script.Util.WSProxy() |
WSProxy | WSProxyInstance | Create WSProxy instance |
Platform.Function.SetObjectProperty(apiObject, propertyName, value) |
Platform Functions | void | Set SOAP object property (legacy) |
String(value) |
Global Functions | string | Convert CLR object to JS string |
Stringify(value) |
Global Functions | string | Object to JSON string (requires Platform.Load) |
Platform.Function.Stringify(object) |
Platform Functions | string | Object to JSON string (no Platform.Load needed) |
Subscriber.Init(key) |
Core Library | SubscriberInstance | Initialize subscriber |
Subscriber.Add(properties) |
Core Library | string | Create subscriber |
Subscriber.Retrieve(filter) |
Core Library | object[] | Retrieve subscribers |
Subscriber.Upsert(properties) |
Core Library | string | Insert or update subscriber |
Subscriber.Statistics(subscriberKey) |
Core Library | object | Subscriber statistics |
<SubscriberInstance>.Update(properties) |
Core Library | string | Update subscriber |
<SubscriberInstance>.Remove() |
Core Library | string | Remove subscriber |
<SubscriberInstance>.Unsubscribe() |
Core Library | string | Unsubscribe from all |
<SubscriberInstance>.Attributes.Retrieve() |
Core Library | object[] | Retrieve subscriber attributes |
<SubscriberInstance>.Lists.Retrieve() |
Core Library | object[] | Retrieve subscriber lists |
SenderProfile.Init(key) |
Core Library | SenderProfileInstance | Initialize sender profile |
SenderProfile.Add(properties) |
Core Library | string | Create sender profile |
<SenderProfileInstance>.Update(properties) |
Core Library | string | Update sender profile |
<SenderProfileInstance>.Remove() |
Core Library | string | Remove sender profile |
SendClassification.Init(key) |
Core Library | SendClassificationInstance | Initialize send classification |
SendClassification.Add(properties) |
Core Library | string | Create send classification |
SendClassification.Retrieve(filter) |
Core Library | object[] | Retrieve send classifications |
<SendClassificationInstance>.Update(properties) |
Core Library | string | Update send classification |
<SendClassificationInstance>.Remove() |
Core Library | string | Remove send classification |
Send.Definition.Init(key) |
Core Library | SendDefinitionInstance | Initialize send definition |
Send.Definition.Add(esdParams, sendClassificationKey, emailKey, listIds) |
Core Library | SendDefinitionInstance | Create send definition |
Send.Definition.AddWithDE(esdParams, sendClassificationKey, emailKey, sendableDataExtensionKey, publicationListKey) |
Core Library | SendDefinitionInstance | Create send def with DE |
Send.Definition.AddWithFilterDefinition(esdParams, sendClassificationKey, emailKey, filterDefinitionKey, listId) |
Core Library | SendDefinitionInstance | Create send def with filter |
Send.Definition.Retrieve([filter]) |
Core Library | object[] | Retrieve send definitions |
<SendDefinitionInstance>.Update(properties) |
Core Library | string | Update send definition |
<SendDefinitionInstance>.Remove() |
Core Library | string | Remove send definition |
<SendDefinitionInstance>.Send() |
Core Library | string | Execute send definition |
Send.Init(id) |
Core Library | SendInstance | Initialize send |
Send.Add(emailKey, listIds, [options]) |
Core Library | SendInstance | Create send |
Send.Retrieve(filter) |
Core Library | object[] | Retrieve sends |
Send.RetrieveLists(filter) |
Core Library | object[] | Lists for send |
<SendInstance>.CancelSend() |
Core Library | string | Cancel send |
<SendInstance>.Remove() |
Core Library | string | Remove send |
Send.Tracking.Retrieve(filter) |
Core Library | object[] | Send tracking |
<SendInstance>.Tracking.ClickRetrieve(filter) |
Core Library | object[] | Click tracking for send |
<SendInstance>.Tracking.TotalByIntervalRetrieve(type, startDate, endDate, groupBy) |
Core Library | object[] | Aggregated send tracking |
SentEvent.Retrieve(filter) |
Core Library | object[] | Sent events |
<StringInstance>.charAt(index) |
ECMAScript Builtins | string | Character at index |
<StringInstance>.charCodeAt(index) |
ECMAScript Builtins | number | Char code at index |
<StringInstance>.concat(string[, ...]) |
ECMAScript Builtins | string | Concatenate strings |
<StringInstance>.indexOf(searchValue[, fromIndex]) |
ECMAScript Builtins | number | First index of substring |
<StringInstance>.lastIndexOf(searchValue[, fromIndex]) |
ECMAScript Builtins | number | Last index of substring |
<StringInstance>.length |
ECMAScript Builtins | number | String length |
<StringInstance>.match(regexp) |
ECMAScript Builtins | array | Match regex |
<StringInstance>.replace(searchValue, replaceValue) |
ECMAScript Builtins | string | Replace substring |
<StringInstance>.search(regexp) |
ECMAScript Builtins | number | Search for regex |
<StringInstance>.slice(start[, end]) |
ECMAScript Builtins | string | Extract substring |
<StringInstance>.split(separator[, limit]) |
ECMAScript Builtins | array | Split into array |
<StringInstance>.substr(start[, length]) |
ECMAScript Builtins | string | Substring by length |
<StringInstance>.substring(start[, end]) |
ECMAScript Builtins | string | Substring by range |
<StringInstance>.toLowerCase() |
ECMAScript Builtins | string | Convert to lower case |
<StringInstance>.toUpperCase() |
ECMAScript Builtins | string | Convert to upper case |
SurveyEvent.Retrieve(filter) |
Core Library | object[] | Survey events |
Platform.Function.SystemDateToLocalDate(date) |
Platform Functions | string | Server to subscriber local time |
Platform.Response.SetResponseHeader(headerName, value) |
Platform Response | void | Set a response header |
Platform.Response.SetCookie(name, value [, expires [, secure]]) |
Platform Response | void | Set a response cookie |
T
| Name | Category | Returns | Description |
|---|---|---|---|
Platform.Function.TreatAsContent(content) |
Platform Functions | string | Evaluate AMPscript/HTML server-side |
Template.Init(key) |
Core Library | TemplateInstance | Initialize template |
Template.Add(properties) |
Core Library | string | Create template |
Template.Retrieve(filter) |
Core Library | object[] | Retrieve templates |
<TemplateInstance>.Update(properties) |
Core Library | string | Update template |
TriggeredSend.Init(key) |
Core Library | TriggeredSendInstance | Initialize TS definition |
TriggeredSend.Add(properties) |
Core Library | TriggeredSendInstance | Create TS definition |
TriggeredSend.Retrieve(filter) |
Core Library | object[] | Retrieve TS definitions |
<TriggeredSendInstance>.Update(properties) |
Core Library | string | Update TS definition |
<TriggeredSendInstance>.Start() |
Core Library | string | Start TS definition |
<TriggeredSendInstance>.Pause() |
Core Library | string | Pause TS definition |
<TriggeredSendInstance>.Publish() |
Core Library | string | Publish TS definition |
<TriggeredSendInstance>.Send(emailAddress, [sendTimeAttributes]) |
Core Library | string | Fire triggered send |
<TriggeredSendInstance>.Tracking.Retrieve([filter]) |
Core Library | object[] | TS tracking |
<TriggeredSendInstance>.Tracking.Clicks.Retrieve(filter) |
Core Library | object[] | TS click tracking |
<TriggeredSendInstance>.Tracking.TotalByInterval.Retrieve(type, startDate, endDate, groupBy) |
Core Library | object[] | TS aggregated tracking |
U
| Name | Category | Returns | Description |
|---|---|---|---|
UnsubEvent.Retrieve(filter) |
Core Library | object[] | Unsubscribe events |
Platform.Function.UpdateData(deName, whereFieldNames, whereFieldValues, fieldNames, fieldValues) |
Platform Functions | number | Update DE rows |
UpdateDE(deName, whereFieldNames, whereFieldValues, fieldNames, fieldValues) |
Platform Functions | number | Alias for UpdateData |
Platform.Function.UrlEncode(url[, encodeReservedKeywords]) |
Platform Functions | string | Percent-encode a full URL |
Platform.Function.UpsertData(deName, whereFieldNames, whereFieldValues, fieldNames, fieldValues) |
Platform Functions | number | Insert or update DE row |
UpsertDE(deName, whereFieldNames, whereFieldValues, fieldNames, fieldValues) |
Platform Functions | number | Alias for UpsertData |
V
| Name | Category | Returns | Description |
|---|---|---|---|
Variable.GetValue(variableName) |
Global Object | string | Read AMPscript variable (alias) |
Variable.SetValue(variableName, value) |
Global Object | void | Write AMPscript variable (alias) |
Platform.Variable.GetValue(name) |
Platform Variable | string | Reads the value of an AMPscript variable |
Platform.Variable.SetValue(name, value) |
Platform Variable | void | Writes a value to an AMPscript variable |
W
| Name | Category | Returns | Description |
|---|---|---|---|
Write(content) |
Global Functions | void | Output to page |
Platform.Response.Write(content) |
Platform Response | void | Write content to the HTTP response output |
All Core Library namespaces — including AccountUser, Portfolio, Folder, DeliveryProfile, SenderProfile, SendClassification, FilterDefinition, and DataExtension.Fields — are indexed in the A–Z sections above. See the Core Library section for full documentation.