Account
Core library namespace for account-level settings and account tracking retrieval.
The Account Core library namespace manages Marketing Cloud account configuration for the current context and exposes static helpers for account retrieval and updates.
Requires Platform.Load("core", "1.1.5") before use.
Methods
| Method | Returns | Description |
|---|---|---|
Account.Init(key) |
AccountInstance | Bind to an account by external key |
Account.Retrieve(filter) |
object[] | Query accounts with a filter |
<AccountInstance>.Update(properties) |
string | Update the initialized account |
Account.Tracking.Retrieve(filter) |
object[] | Account-level send tracking data |
Account.Init
Initializes an Account instance for the given external key. Call this before any instance method on the returned object.
Syntax
Account.Init(key)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
key |
string | Yes | External key of the account |
Return value
AccountInstance — an object bound to that account.
Examples
Platform.Load("core", "1.1.5");
var myAccount = Account.Init("MyCustomerKey");
Account.Retrieve
Retrieves account objects that match the filter (WSProxy-style Property / SimpleOperator / Value or a compatible filter object).
Syntax
Account.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | Criteria used to search for the account |
Return value
object[] — rows matching the filter.
Examples
Platform.Load("core", "1.1.5");
var getAcct = Account.Retrieve({ Property: "CustomerKey", SimpleOperator: "equals", Value: "MyAccount" });
<AccountInstance>.Update
Updates the account represented by the instance. If properties includes TimeZoneID, the account time zone is updated to that value.
Syntax
<AccountInstance>.Update(properties)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
properties |
object | Yes | Account attributes to change |
Return value
"OK" on success, or the call throws on failure.
Examples
Platform.Load("core", "1.1.5");
var myAccount = Account.Init("MyCustomerKey");
var status = myAccount.Update({ FromName: "Demo From Name" });
Account.Tracking.Retrieve
Returns tracking data for sends associated with accounts that match the filter. This is a static call on Account.Tracking; you do not need Account.Init() first.
Syntax
Account.Tracking.Retrieve(filter)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
filter |
object | Yes | Criteria used to narrow accounts / tracking rows |
Return value
object[] — tracking records matching the filter.
Examples
Platform.Load("core", "1.1.5");
var acctTracking = Account.Tracking.Retrieve({
Property: "CustomerKey",
SimpleOperator: "equals",
Value: "MyAccount"
});