Platform Functions — ssjs.guide

All methods documented here are accessed as Platform.Function.MethodName(...). No Platform.Load call is required.

Data Extensions

Read and write rows in SFMC Data Extensions.

Get a single field value from a DE row matching filter criteria.

Get multiple rows from a DE matching filter criteria.

LookupOrderedRows

Get sorted rows with a max count and filter.

Add a new row to a Data Extension.

Modify existing rows matching filter criteria.

Insert or update a row based on filter match.

Remove rows matching filter criteria.

DataExtensionRowCount

Count all rows in a Data Extension.

Alias for InsertData.

Alias for UpdateData.

Alias for UpsertData.

Alias for DeleteData.

Strings

Extract part of a string (1-based indexing).

Remove leading and trailing whitespace.

Substitute all occurrences of a substring.

Zero-based position of the first substring occurrence.

Number of characters in a string.

Convert to uppercase.

Convert to lowercase.

Convert to title case.

Character for a given ASCII code.

Join two or more strings.

Format a value using a .NET format string.

Dates

Current SFMC server date and time.

Add an interval to a date.

Difference between two dates in a given interval.

Convert a string to a date object.

Format a date into a string pattern.

SystemDateToLocalDate

Convert system date to subscriber's local timezone.

Logic & Utility

Parse a JSON string to a JavaScript object. SSJS equivalent of JSON.parse().

Generate a new globally unique identifier string.

Validate a string as an email address format.

Evaluate whether a string is a valid phone number.

Check if a value is null.

Check if a string is null, empty, or whitespace.

Inline if — return one of two values based on a condition.

URL-encode a string for safe use in query parameters.

Build an encrypted CloudPages URL with optional parameters.

Generate a tracking URL for a microsite page.

Safely retrieve a subscriber attribute value.

Stop execution and raise an error with optional skip-send.

Redirect the browser to a specified URL.

Encryption & Encoding

Encode a string to Base64.

Decode a Base64-encoded string.

Compute the SHA-256 hash of a string.

Compute the SHA-512 hash of a string.

Compute the MD5 hash of a string.

EncryptSymmetric

Encrypt a string with AES or other symmetric algorithm.

DecryptSymmetric

Decrypt a symmetrically encrypted string.

AMPscript Bridge

Retrieve the value of an AMPscript variable.

Assign a value to an AMPscript variable.

Evaluate an AMPscript/HTML string and return rendered output.

SOAP API Helpers

Low-level SOAP API wrappers. For most SOAP operations, prefer WSProxy instead.

Instantiate a Marketing Cloud SOAP API object.

SetObjectProperty

Set a property on a SOAP API object.

AddObjectArrayItem

Append an item to a SOAP API object array property.

Execute a SOAP Create call.

Execute a SOAP Retrieve call.

Execute a SOAP Update call.

Execute a SOAP Delete call.

Execute a SOAP Perform action.

InvokeConfigure

Execute a SOAP Configure call.

Execute a SOAP Execute call.

Execute a SOAP Extract call.

Execute a SOAP Schedule call.

HTTP

Simple HTTP functions — for full REST support see Script.Util.HttpRequest.

Perform an HTTP GET request. Supports custom headers.

Perform an HTTP POST with content type and payload.

HTTPRequestHeader

Get the value of an incoming HTTP request header.

Content

ContentBlockByKey

Render a Content Builder asset by customer key (global).

ContentBlockByName

Render a Content Builder asset by folder path and name (global).

ContentBlockByID

Render a Content Builder asset by numeric ID (global).

ContentImageByKey

Output an img tag for a Content Builder image by external key.

ContentImageByID

Output an img tag for a Content Builder image by numeric ID.

BeginImpressionRegion

Start a named impression tracking region.

EndImpressionRegion

End an impression region (optionally close all nested).