SenderProfile
Core library SenderProfile — from-name / from-address profiles (Core library has no Retrieve here).
SenderProfile manages sender profiles (From name, From address, etc.). SenderProfile methods only run on CloudPages / landing pages — they cannot run inside an email message at send time.
There is no SenderProfile.Retrieve in this Core namespace; use Init with a known key or query via WSProxy when you need discovery.
Requires Platform.Load("core", "1.1.5") before use.
Methods
| Method | Returns | Description |
|---|---|---|
SenderProfile.Init(key) |
SenderProfileInstance | Bind by external key |
SenderProfile.Add(properties) |
string | Create a sender profile |
<SenderProfileInstance>.Update(properties) |
string | Update the initialized profile |
<SenderProfileInstance>.Remove() |
string | Delete the profile |
SenderProfile.Init
Initializes a SenderProfile instance for the given external key.
Syntax
SenderProfile.Init(key)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
key |
string | Yes | External key |
Return value
SenderProfileInstance
Examples
Platform.Load("core", "1");
var myProfile = SenderProfile.Init("mySenderProfile");
SenderProfile.Add
Creates a new sender profile with the specified properties.
Syntax
SenderProfile.Add(properties)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
properties |
object | Yes | Name, CustomerKey, Description, FromName, FromAddress, … |
Return value
"OK" on success.
Examples
Platform.Load("core", "1.1.5");
var newSP = {
Name: "SSJS Added Send Profile",
CustomerKey: "test_send_profile",
Description: "An SSJS Added Profile",
FromName: "Andrea Cruz",
FromAddress: "acruz@example.com"
};
var status = SenderProfile.Add(newSP);
<SenderProfileInstance>.Update
Updates the initialized sender profile with the given properties.
Syntax
<SenderProfileInstance>.Update(properties)
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
properties |
object | Yes | Attributes to change |
Return value
"OK" on success.
Examples
Platform.Load("core", "1.1.5");
var myProfile = SenderProfile.Init("mySenderProfile");
var status = myProfile.Update({ Name: "SSJS Updated Sender Profile" });
<SenderProfileInstance>.Remove
Removes the initialized sender profile.
Syntax
<SenderProfileInstance>.Remove()
Return value
"OK" on success.
Examples
Platform.Load("core", "1.1.5");
var myProfile = SenderProfile.Init("mySenderProfile");
var status = myProfile.Remove();