Holds the payload for each call

Wrapper to use for JWT authentication.

Requires a JWT token as a request parameter either as POST or GET. If token is invalid or not given, a redirect to the error page will occur. Required parameter name: 'jwt'

NOTE: JWT token cannot be used in conjunction with CloudPagesURL as the function cannot handle "=" characters which are used as padding in a base64 encoded string. Use a standard GET URL parameter instead.

Wrapper to use for LOGIN authentication.

Requires a cookie as a JWT token. Name of the cookie can be set in the settings. Requires a login page to generate a token after successfully authenticated.

The default login page can be set in thr config: cp.login.

Expire a cookie.

Expire cookie and redirect back to login.

Set a new cookie or overwrite an existing one.

Validate the payload against QueryStringParameter.

If QueryStringParameter was found it is save at runtime to cp.payload. E.g.: cp.payload.qs.subscriberKey.

Generate a new JWT token.

Decode a JWT token from base64.

Validate a JWT token signature

Redirect to the error page or the given redirectUrl

Retrieve an API token.

This function retrieves a saved api token from a dataextension or generate a new token.

Validate an API token.

Trigger a journey entry event.

Requires a DataExntesion (DE) to be used in conjunction with a journey entry source.

// trigger a journey
var rest = new sfmcApi();
var data = {
    'email': 'info@email360.io',
    'name': 'John'
};
var resp = rest.triggerJourneyEvent(data.email,'APIEvent-b14f22b4-79f2-e573-ebaf-53ad4fa60f63',data);

Create an image asset

Gets a list of send definitions.

Note: Accepted filter values are active, inactive, or deleted. Valid operations are eq and neq. Example: 'status neq active'

var rest = new sfmcApi();

// retrieve all Send Definitions
var resp = rest.retrieveSendDefinitions(null,true);

// retrieve only with status not equal to active
var resp = rest.retrieveSendDefinitions({filter:'status neq active'});

Email preview

This call will output a rendered version of the email utilizing information provided by the url.

Email preview by SubscriberId or SubscriberKey

This call will output a rendered version of the email utilizing information stored in Contact Attributes (aka Subscriber Attributes) only.

var rest = new sfmcApi();

// use SubscriberKey
var resp = emailPreviewContact(23141,"key:03ABDDST67SEA8")

// use SubscriberId
var resp = emailPreviewContact(23141,"id:1241157")

Email preview by List

This call will output a rendered version of the email utilizing the architecture of a list (but not a specific contact).

Email preview by ListSubscriber

This call will output a rendered version of the email utilizing contact information (via ContactID) stored in a specific list or group (assigned by ListID or GroupID).

Email preview by ListSubscriber

This call will output a rendered version of the email utilizing contact information (via ContactID) stored in a specific list or group (assigned by ListID or GroupID).

Email preview by DataExtension and SubscriberId

This call will output a rendered version of the email utilizing contact information (via ContactID) stored in a specific data extension (assigned by DE ID).

Email preview by DataExtension and SubscriberKey

This call will output a rendered version of the email utilizing contact information (via ContactID) stored in a specific data extension (assigned by DE ID).

Email preview by DataExtension row

This call will output a rendered version of the email utilizing a row number (assigned by inside of the specified data extension

Send a test email

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

Note, the Send Classification, Delivery Profile and Sender Profile IDs will need to be collected via the associated SOAP API objects or via UI as there currently is no REST endpoint that can gather this information. In the UI copy the URL for your Send Classification and use the 18 digigt parameter id "g"

var rest = new sfmcApi();
var recipients = [
    'info@email360.io'
];

// Send a test email rendered with a profile from a subscriberId inside a specific list
var dataSource = {
    contact: "id:1234567", // subscriberId
    type: "List",
    id: 1234 // list id
};
var resp = rest.sendTestEmail(3321,recipients,dataSource,"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

// Send a test email rendered with a profile from a subscriberKey inside a dataExtension
var dataSource = {
    contact: "key:03ad24jd81ja74grhe", // subscriberKey
    type: "DataExtension",
    id: "key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // External Key of the DataExtension
};
var resp = rest.sendTestEmail(3321,recipients,dataSource,"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

// Send a test email rendered with a profile of a DataExtension Row
var dataSource = {
    row: 1, //The row number to use from the given DataExtension
    type: "DataExtension",
    id: "key:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" // External Key of the DataExtension
};
var resp = rest.sendTestEmail(3321,recipients,dataSource,"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx");

Initiates a message to one or more mobile numbers.

In order to be able to programmatically trigger text messages, MobileConnect needs to be enabled in Marketing Cloud’s Mobile Studio. The phone number must use the correct format for the designated country code. For example, a mobile number from the United States must include the numerical country code 1 and the area code, eg: 13175551212.

To ensure that the mobile number exists for the contact and that the contact subscribed to the specified keyword on your short code, set the Subscribe and Resubscribe values to true and specify the keyword parameter.

Retrieves the overall delivery status of a message to a contact.

Create a Script Activity

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

Retrieve a specific Script Activity

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

Retrieve all Script Activities

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

var rest = new sfmcApi();

// retrieve all ScriptActivities
var resp = rest.retrieveScriptActivities(null,true);

// retrieve page 2 with a pagesize of 10
var resp = rest.retrieveScriptActivities({page:1,pagesize:10});

Retrieve a retrieveScriptActivityId by a given name

Retrieve all Script Activities inside a folder

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

Retrieve a ScriptAcitvity FolderId

Retrieve a ScriptAcitvity CustomerKey

Retrieve a ScriptAcitvity Description

Retrieve a ScriptAcitvity Script

Retrieve a ScriptAcitvity Status

Retrieve a ScriptAcitvity CreatedDate

Retrieve a ScriptAcitvity ModifiedDate

Validate a Script

This will let you validate your SSJS prior to creation or update inside the system. The return is a boolean value, essentially pass/fail. Please note this is just for validation of the code, it does not verify the dependents (content areas, DEs, etc.) so it does not guarantee there will be no errors when run.

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

Update an existing Script Activity

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

Update the name of an existing Script Activity.

Update the description of an existing Script Activity.

Replace the script of an existing Script Activity.

Update the customerKey of an existing Script Activity.

Move an existing Script Activity

Starts a Script Activity

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

Delete a Script Activity

Note: This is an internal only route, that currently is NOT supported. It should only be used in production environments wiht caution. The route has no ownership internally, and could stop working without notice.

The WSProxy API instance.

this.api.retrieveItem()

Retrieves all retrievable columns for the given object.

// retrieve cols for DataExtension
var cols = prox.retrievableCols('DataExtension');

Match cols with request result of a retrieve

A retrieve request result is returning many informations which are not useable if the same object will be used to create or update informations. This function takes the retrieveable cols and match the values against the original request result.

Create a DataExtension within SFMC.

Sample list of the field array required to generate the DataExtension

[
   {
       "Name": "Text",
       "FieldType": "Text",
       "MaxLength": 50,
       "DefaultValue": "Hellow world"
   },
   {
       "Name": "Number",
       "FieldType": "Number"
   },
   {
       "Name": "Date",
       "FieldType": "Date"
   },
   {
       "Name": "Boolean",
       "FieldType": "Boolean",
       "DefaultValue": false
   },
   {
       "Name": "Email",
       "FieldType": "EmailAddress"
   },
   {
       "Name": "Phone",
       "FieldType": "Phone"
   },
   {
       "Name": "Decimal",
       "FieldType": "Decimal",
       "MaxLength": 18,
       "Scale": 2
   },
   {
       "Name": "Locale",
       "FieldType": "Locale"
   }
]

For a full and up to date list of available field types, visit Salesforce Marketing Cloud documantation.

// Create a new DataExtension inside the folder DataExtensions
var prox = new wsproxy();
var resp = prox.createDataExtension('MyNewDataExtension', [{
       "Name": "Text",
       "FieldType": "Text",
       "MaxLength": 50,
       "DefaultValue": "Hellow world"
   }]);

Create a DataExtension with "num" random records.

// Create a new demo DataExtension inside the folder DataExtensions with 100 random records
var prox = new wsproxy();
var resp = prox.createDataExtensionDemo('MyNewDataExtension', 100);

Retrieve informations about a single DataExtension.

// Retrieve informations about a sepcific DataExtension
var prox = new wsproxy();
var resp = prox.retrieveDataExtension('MySampleDataExtension');

// using a customerKey
var resp = prox.retrieveDataExtension('53b54b8a-b604-4fc2-90x9-33eec99c8a93');

Retrieve a list of all DataExtension(s) in the business unit.

// Retrieve all DataExtensions
var prox = new wsproxy();
var resp = prox.retrieveDataExtensions(NULL,true);

Retrieves a property of a DataExtension.

Retrieve the CustomerKey of the given DataExtension.

Retrieve the Name of the given DataExtension.

Retrieve the ObjectID of the given DataExtension.

Retrieve the CategoryID of the given DataExtension.

Retrieve the ModifiedDate of the given DataExtension.

Note: ModifiedDate is the the last modification of the properties for the given DataExtension. This does not apply to changes of the data within the DataExtension.

Retrieve a list of all DataExtension Names.

Retrieve a list of all DataExtension CustomerKeys.

Find DataExtension(s) which have no folder allocation

If a folder has been deleted and it contained any DataExtension, these DataExtension will no longer be visible in the UI as their shared CategoryID is referring to a non-existing folder.

Retrieves the folder path for a DataExtension.

Check if a DataExtension with the given id already exists.

Check if folder is a ContentType of DataExtension

Move a DataExtension.

Moving a DataExtension from one folder to another requires the change of it’s CategoryID attribute.

Delete a DataExtension

Copy a DataExtension

Clear all records inside a DataExtension.

Rename a DataExtension

Update the properties of a DataExtenion

// changing the name of a DataExtension
var prox = new wsproxy();
var prop = { Name: "MyNewDataExtensionName" }
var resp = prox.updateDataExtension('MyNewDataExtension',prop);

// change the DataExtension to be sendable
var prop = { 
    IsSendable: "true",
    SendableDataExtensionField: {
        Name: "email", //Provide the name of the field used to establish a data relationship
        DataType: "EmailAddress"
    },
    SendableSubscriberField: {
        Name: "Subscriber Key"
    } //Use "Subscriber Key" or "Email Address" depending on whether the SUBSCRIBER_KEY business rule has been turned on.
}
var resp = prox.updateDataExtension('MyNewDataExtension',prop);

Retrieve informations about a single DataExtentionTemplate.

// Retrieve informations about a sepcific DataExtentionTemplate
var prox = new wsproxy();
var resp = prox.retrieveDataExtentionTemplate('MySampleDataExtension');

// using a customerKey
var resp = prox.retrieveDataExtentionTemplate('53b54b8a-b604-4fc2-90x9-33eec99c8a93');

Retrieve a list of all DataExtentionTemplate(s) in the business unit.

Retrieves a property of a DataExtentionTemplate.

Retrieve the CustomerKey of the given DataExtentionTemplate.

Retrieve the Name of the given DataExtentionTemplate.

Retrieve the ObjectID of the given DataExtentionTemplate.

Retrieve the CategoryID of the given DataExtentionTemplate.

Retrieve the ModifiedDate of the given DataExtentionTemplate.

Note: ModifiedDate is the the last modification of the properties for the given DataExtentionTemplate. This does not apply to changes of the data within the DataExtentionTemplate.

Retrieve a list of all DataExtentionTemplate Names.

Check if a DataExtentionTemplate with the given id already exists.

Delete a DataExtentionTemplate

Create new records inside the given DataExtension.

To avoid the cumbersome Name-Value pair structure, the data object will be converted. Expecting the following sample object:

{
     Firstname: "John",
     Lastname: "Peter"
}

// create 1 record in DataExtension with name "MyDataExtension"
var prox = new wsproxy();
var resp = prox.createDataExtensionRecords('MyDataExtension',[{SubscriberKey:"123-345-123",Firstname:"John",Lastname:"Smith"}]);

// create 2 records in DataExtension with name "MyDataExtension"
var resp = prox.createDataExtensionRecords('MyDataExtension',[
           {SubscriberKey:"123-345-123",Firstname:"John",Lastname:"Smith"},
           {SubscriberKey:"456-654-321",Firstname:"Mike",Lastname:"Do"}
]);

Retrieve records inside a DataExtension.

In order to select all data from a DataExtension, the DataExtension field names need to be collected. After retrieving the field names, all data can be retrieved. Optional, the selection of the data can be filtered or only the first 2,500 records can be retrieved.

// retrieve all records from 'MyDataExtension' where 'Number' is larger than 10
var prox = new wsproxy();
var filter = {
    Property: "Number",
    SimpleOperator: "greaterThan",
    Value: 10
};
var resp = prox.retrieveDataExtensionRecords('MyDataExtension', filter, true)

Update or Add one or multiple records inside a DataExtension.

Update only works with a Primary Key (PK) on the given DataExtension. To avoid the cumbersome Name-Value pair structure, the data object will be converted. Expecting the following sample object:

{
     Firstname: "John",
     Lastname: "Peter"
}.

// update or add 1 record in DataExtension with name "MyDataExtension"
var prox = new wsproxy();
var resp = prox.upsertDataExtensionRecords('MyDataExtension',[
    {SubscriberKey:"123-345-123",Firstname:"John",Lastname:"Smith"}
]);

Delete one or multiple records inside a DataExtension.

To avoid the cumbersome Name-Value pair structure, the data object will be converted. Expecting the following sample object:

{
     PrimaryKey: "john.peter@gmail.com"
}.

// delete one record in 'MyDataExtension' with the PrimaryKey: 'SubscrinberKey' equals '123-345-123' 
var prox = new wsproxy();
var resp = prox.deleteDataExtensionRecords('MyDataExtension', [{ SubscriberKey: "123-345-123" }] )

Create DataExtension fields within the DataExtension.

A sampe field array required to generate the new field within the DataExtension

[
   {
       "Name": "Text",
       "FieldType": "Text",
       "MaxLength": 50,
       "DefaultValue": "Hellow world"
   }
]

For a full and up to date list of available field types, visit Salesforce Marketing Cloud documantation.

// create a field in the DataExtension 'MyDataExtension'
var prox = new wsproxy();
var fields = [{
         Name: "Firstname",
         FieldType: "Text",
         MaxLength: 100
     }];
var resp = prox.createDataExtensionFields('MyDataExtension', fields);

Retrieve a list of all Fields for the given DataExtension.

Retrieve the field names of a DataExtension.

Retrieves a single field property of a DataExtension.

Retrieve the CustomerKey of the given DataExtension and field name.

Retrieve the ObjectID of the given DataExtension and field name.

future release

future release

Create a folder under a parent folder.

Retrieve folder informations.

Attention: Folder names are not unique. If multiple folder were found, resp.Status returns OK. Each folder will create an array entry in the resp.Result set. To identify multiple folders use resp.Result.length > 1 and act accordantly. This will not occur when passing the folder id as parameter.

// retrive data folder information for the folder id 'Data Extensions'
var prox = new wsproxy();
var resp = prox.retrieveDataFolder('Data Extensions');

Retrieves all DataFolders for a given contentType.

// Retrieve every DataFolder with a parent folder ID is equal to 123 and limit the result by 2
var prox = new wsproxy();
var resp = prox.retrieveDataFolders(
    {
        Property:"ParentFolder.ID", 
        SimpleOperator: "equals", 
        Value: 123
    },{BatchSize:2}
);

Retrieves the folder path for the requested object.

Retrieves a property for a folder.

Retrieves the folderId.

Retrieves the folder Name.

Retrieves the folder ObjectID.

Retrieves the folder ContentType.

Retrieves the folder CustomerKey.

Delete a folder.

Check if a folder exists

Check if a folder is empty based on contentType.

In order to determine if a data folder is empty, it is necessary to retrieve all objects with the same parent folderId as the requested folderId. This requires an allocation between the contentType of the folder and the required object. There is no such allocation and an object map has been created inside this method.

Rename a folder

future release

Retrieve Subscriber records.

By retrieving a subscriber, you can view the applicable information for that subscriber. You can include this information in a profile center or in your own application as part of a screen that displays subscriber information

// retrieve all Subscriber records where 'CreatedDate' is after '4th of January 2012'
var prox = new wsproxy();
var filter = {
    Property: "CreatedDate",
    SimpleOperator: "greaterThan",
    Value: "2012-01-04T10:19:00"
};
var resp = prox.retrieveSubscribers(filter, true)

Update a Subscriber record

Updating an existing subscriber via the WSProxy allows you to better maintain your subscriber information while utilizing a tight integration with your system or development environment.

// update a record
var prox = new wsproxy();
var resp = prox.upsertSubscriberRecords([
     {
         Email: 'info@email360.io',
         SubscriberKey: 'SomeUniqueKey',
             Attributes: {
                 "First Name": 'John',
                 "Last Name": 'Doe'
             }
     }
]);

Delete one or multiple records from Subscribers.

If you wish to entirely remove a subscriber from your account, you can use this call to delete the subscriber's information.

You don't need to delete a subscriber's information from your account in order to unsubscribe that subscriber from an email list. Use this call only when you wish to totally remove a subscriber's information from your account.

When you delete a subscriber, your account also loses all tracking information related to that subscriber and a new instance of that subscriber could be added to lists from which that subscriber has previously unsubscribed. For this reason, Marketing Cloud recommends editing subscribers to an unsubscribed status rather than deleting that subscriber.

Retrieve Tracking Data

In most production implementations, data volume in the account requires you to include specific JobIDs in the filter criteria of the request. If requests that don’t specify a JobID time out during processing, add a JobID in the filter. If specifying a JobID is not possible, or if your implementation requires a broad range of JobIDs, use a data extract-based procedure instead.

Retrieve Tracking Data for the OpenEvent

Retrieve Tracking Data for the ClickEvent

Retrieve Tracking Data for the BounceEvent

Retrieve Tracking Data for the UnsubEvent

Retrieve information about an Automation

Retrieve a list of all Automation(s) in the business unit.

Trigger an automation

Trigger an automation with a wait timer

This call is helpful if you want to trigger an automation which may already be in progress, but you need to ensure it starts as soon as it has finished. If the automation already runs, the script will wait n milliseconds (sleep) and retry it for the duration of x repetitions (repeat).

The maximum duration is sleep * repeat.

future release

Creates a TSQL Query

Retrieve informations about a single QueryDefinition.

// Retrieve informations about a sepcific QueryDefinition
var prox = new wsproxy();
var resp = prox.retrieveQueryDefinition('MySample');

// using a customerKey
var resp = prox.retrieveQueryDefinition('53b54b8a-b604-4fc2-90x9-33eec99c8a93');

Retrieve a list of all QueryDefinition(s) in the business unit.

Retrieves a property of a QueryDefinition.

Retrieve the CustomerKey of the given QueryDefinition.

Retrieve the Name of the given QueryDefinition.

Retrieve the ObjectID of the given QueryDefinition.

Retrieve the CategoryID of the given QueryDefinition.

Retrieve a list of all QueryDefinition Names.

Delete a QueryDefinition

Execute a TSQL Query

Retrieve the status of a TSQL query after it has been executed

Check if a QueryDefinition has status complete.

This function reapeats itself as long as the status is complete or timedout.

Retrieve informations about an asset.

This usage of this function is limited as the retrievebale cols are not fully supported for WSProxy at this time. Only ObjectID, CustomerKey ID and Name are retrieveable but no information about the file itself. In order to retrieve more informations about the asset, use the REST API.

Create a ScriptContentBlock asset

Create an image asset

Note: This function will create an image but the return object does not hold any informations about the image itself. This may change in a later stage when SFMC is adding these informations. If these informations are required, use the REST API function instead.

Unsuscribe a recipient

The LogUnsubEvent api call allows you to unsubscribe a subscriber and log an ‘UnsubEvent’ that is tracked against a specific job. This is mostly used for custom preference centers or unsubscribe pages.

By using this call, you are able to track back the unsubscribe to the job that the email was sent, instead of just a general non-trackable unsubscribe.

future release

future release

Retrieve informations about a single TriggeredSendDefinition.

// Retrieve informations about a sepcific TriggeredSendDefinition
var prox = new wsproxy();
var resp = prox.retrieveTriggeredSendDefinition('MySample');

// using a customerKey
var resp = prox.retrieveTriggeredSendDefinition('53b54b8a-b604-4fc2-90x9-33eec99c8a93');

Retrieve a list of all TriggeredSendDefinition(s) in the business unit.

Retrieves a property of a TriggeredSendDefinition.

Retrieve the CustomerKey of the given TriggeredSendDefinition.

Retrieve the Name of the given TriggeredSendDefinition.

Retrieve the ObjectID of the given TriggeredSendDefinition.

Retrieve the CategoryID of the given TriggeredSendDefinition.

Retrieve the TriggeredSendStatus of the given TriggeredSendDefinition.

Retrieve a list of all TriggeredSendDefinition Names.

Retrieve a list of all Active TriggeredSendDefinitions.

Retrieve the a TriggeredSendSummary.

Retrieve the Bounces of the given TriggeredSend.

Retrieve the Clicks of the given TriggeredSend.

Retrieve the Conversions of the given TriggeredSend.

Retrieve the InProcess of the given TriggeredSend.

Retrieve the CreatedDate of the given TriggeredSend.

Retrieve the ModifiedDate of the given TriggeredSend.

Retrieve the NotSentDueToError of the given TriggeredSend.

Retrieve the NotSentDueToOptOut of the given TriggeredSend.

Retrieve the NotSentDueToUndeliverable of the given TriggeredSend.

Retrieve the ObjectID of the given TriggeredSend.

Retrieve the Opens of the given TriggeredSend.

Retrieve the OptOuts of the given TriggeredSend.

Retrieve the Queued of the given TriggeredSend.

Retrieve the Sent of the given TriggeredSend.

Retrieve the UniqueClicks of the given TriggeredSend.

Retrieve the UniqueConversion of the given TriggeredSend.

Retrieve the UniqueOpens of the given TriggeredSend.

Send a triggered email send

var prox = new wsproxy();
var recp = [
    {
        EmailAddress: 'info@email360.io',
        SubscriberKey: 'info@email360.io',
        Attributes: {
            FirstName: "John",
            LastName: "Do"
        }
    }
];
var resp = prox.sendTriggeredSend(381,recp);