__construct

Default constructor

Parameters

login string

Login provided for API access.

password string

The password.

key string

Manager Key copied from the CCMD web application.

server string (optional)

The server to use. Ask your account-manager.

Return

void

fromLongXML

Convert a long into a string

Parameters

value string

The value to convert.

Return

string

toLongXML

Convert a x into a long

Parameters

value string

The value to convert.

Return

string

setTimeOut

Set the timeout
After this time the request will stop. You should handle any errors triggered by this.

Parameters

seconds int

The timeout in seconds.

Return

void

setUserAgent

Set the user-agent for you application
It will be appended to ours, the result will look like: "PHP Campaign Commander/<version> <your-user-agent>"

Parameters

userAgent string

Your user-agent, it should look like <app-name>/<app-version>.

Return

void

closeApiConnection

Close the connection

Return

bool true if the connection was closes, otherwise false.

createEmailMessage

Create email-message.

Parameters

name string

Name of the message.

description string

Description of the message.

subject string

Subject of the message.

from string

From name.

fromEmail string

From email-address.

to string

To name.

body string

Body of the email.

encoding string

Encoding to use.

replyTo string

Reply-to name.

replyToEmail string

Reply-to email.

bounceback bool (optional)

Use as bounceback message?

unsubscribe bool (optional)

Use unsubscribe feature of Windows Live Mail.

unsublinkpage string (optional)

Unjoin URL, imporve deliverability displaying a unsubscribe button in Windows Live Mail.

Return

string The message ID.

createEmailMessageByObj

Create email-message.

Parameters

message array

The message object.

Return

string The message ID.

createSmsMessage

Create SMS-message.

Parameters

name string

Name of the message.

desc string

Description of the message.

from string

From name.

body string

Body of the SMS.

Return

string The message ID.

createSmsMessageByObj

Create SMS-message.

Parameters

message array

The message object.

Return

string The message ID.

deleteMessage

Delete message.

Parameters

id string

ID of the message.

Return

bool true if delete was successful.

updateMessage

Update a message field.

Parameters

id string

ID of the message.

field string

The field to update.

value mixed

The value to set.

Return

bool true if the update was successful.

updateMessageByObj

Update email-message.

Parameters

message array

The message object.

Return

bool true if the update was successful.

cloneMessage

Clone a message.

Parameters

id string

ID of the message.

newName string

Name of the newly created message.

Return

string ID of the newly created message.

getMessage

Get message.

Parameters

id string

ID of the message.

Return

object The message object.

getLastEmailMessages

Get last email-messages.

Parameters

limit int

Maximum number of messages to retrieve.

Return

array IDs of messages.

getLastSmsMessages

Get last SMS-messages.

Parameters

limit int

Maximum number of messages to retrieve.

Return

array IDs of messages.

getEmailMessagesByField

Get email-messages by field.

Parameters

field string

Field to search.

value mixed

Value to search.

limit int

Maximum number of messages to retrieve.

Return

array IDs of messages matching the search.

getSmsMessagesByField

Get SMS-messages by field.

Parameters

field string

Field to search.

value mixed

Value to search.

limit int

Maximum number of messages to retrieve.

Return

array IDs of messages matching the search.

getMessagesByPeriod

Get messages by period.

Parameters

dateBegin int

Begin date of the period.

dateEnd int

End date of the period.

Return

array IDs of messages matching the search.

getEmailMessagePreview

Get email-message preview.

Parameters

messageId string

ID of the message.

part string (optional)

Part of the message to preview (HTML or text).

Return

string Preview of the message.

getSmsMessagePreview

Get SMS-message preview.

Parameters

messageId string

ID of the message.

Return

string Preview of the SMS-message.

trackAllLinks

Activate tracking for all links.

Parameters

id string

ID of the message.

Return

array

untrackAllLinks

Deactivate link tracking for all links.

Parameters

id string

ID of the message.

Return

bool true if the untrack operation was successful.

trackLinkByPosition

Tracks a link based on its position in an email.

Parameters

id string

ID of the message.

position string

Position of the link to update in the message.

part string (optional)

HTML or text.

Return

array The order number of the URL.

getAllTrackedLinks

Get a list of all teh tracked links in an email.

Parameters

id string

ID of the message.

Return

array List of IDs of the tracked links.

getAllUnusedTrackedLinks

Retrieves the unused tracked links for an email.

Parameters

id string

ID of the message.

Return

array List of IDs of the unused tracked links.

getAllTrackableLinks

Retrieves all the trackable links in an email.

Parameters

id string

ID of the message.

Return

array List of IDs of the trackable links.

testEmailMessageByGroup

Sends a test email campaign to a group of recipients.

Parameters

id string

The ID of the message to test.

groupId string

The ID of the group to use for the test.

campaignName string

The name of the test campaign.

subject string

The subject of the message to test.

part string (optional)

The part of the message to send, allowed values are: HTML, TXT, MULTIPART.

Return

true if successfull, false otherwise.

testEmailMessageByMember

Sends a test email campaign to a member.

Parameters

id string

The ID of the message to test.

memberId string

The ID of the member to use for the test.

campaignName string

The name of the test campaign.

subject string

The subject of the message to test.

part string (optional)

The part of the message to send, allowed values are: HTML, TXT, MULTIPART.

Return

true if successfull, false otherwise.

testSmsMessage

Sends a test email campaign to a member.

Parameters

id string

The ID of the message to test.

memberId string

The ID of the member to use for the test.

campaignName string

The name of the test campaign.

Return

true if successfull, false otherwise.

getDefaultSender

Retrieves the email address of the default sender.

Return

string The email address of the default sender.

getValidatedAltSenders

Get a list of validated alternate senders.

Return

array The list of email addresses.

getNotValidatedSenders

Get a list of not validated alternate senders.

Return

array The list of email addresses.

createStandardUrl

Creates a standard link for an email.

Parameters

messageId string

ID of the message.

name string

Name of the URL.

url string

URL to add.

Return

string ID of the created URL.

createAndAddStandardUrl

Scans your message from top to bottom and replaces first occurrence of &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the standard link order number).

Parameters

messageId string

The ID for the message.

name string

The name of the URL.

url string

The url of the link.

Return

int The order number of the url.

createUnsubscribeUrl

Creates an unsubscribe link for an email.

Parameters

messageId string

ID of the message.

name string

Name of the URL.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string ID of the created URL.

createAndAddUnsubscribeUrl

Scans your message from top to bottom and replaces the first occurrence of &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the unsubscribe link order number).

Parameters

messageId string

ID of the message.

name string

Name of the URL.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string The order number of the url.

createPersonalisedUrl

Creates an personalised link for an email

Parameters

messageId string

ID of the message.

name string

Name of the URL.

url string

URL to add.

Return

string The order number of the URL.

createAndAddPersonalisedUrl

Scans your message from top to bottom and replaces the first occirrence of &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the personalized link order number).

Parameters

messageId string

ID of the message.

name string

Name of the URL.

url string

URL to add.

Return

string The order number of the URL.

createUpdateUrl

Creates an update URL.

Parameters

messageId string

ID of the message.

name string

Name of the URL.

parameters mixed

Update parameters to apply to the member table (for a particular member).

pageOk string

Url to call when unsubscribe was successful.

messageOk string

Message to display when unsubscribe was successful.

pageError string

Url to call when unsubscribe was unsuccessful.

messageError string

Message to display when unsubscribe was unssuccessful.

Return

string The order number of the URL.

createAndAddUpdateUrl

Scans your message from top to bottom and replaces the first occirrence of &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the update link order number).

Parameters

messageId string

ID of the message.

name string

Name of the URL.

parameters mixed

Update parameters to apply to the member table (for a particular member).

pageOk string

Url to call when unsubscribe was successful.

messageOk string

Message to display when unsubscribe was successful.

pageError string

Url to call when unsubscribe was unsuccessful.

messageError string

Message to display when unsubscribe was unssuccessful.

Return

string The order number of the URL.

createActionUrl

Creates an action link for an email.

Parameters

messageId string

The ID of the message to which to add a URL.

name string

The name of the URL.

action string

The action to perform.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

The order number of the URL.

createdAndAddActionUrl

Scans your message from top to bottom and replaces the first occirrence of &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the action link order number).

Parameters

messageId string

The ID of the message to which to add a URL.

name string

The name of the URL.

action string

The action to perform.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

The order number of the URL.

createMirrorUrl

Creates a mirror URL for an email.

Parameters

messageId string

ID of the message.

name string

Name of the URL.

Return

string The order number of the url.

createAndAddMirrorUrl

Scans your message from top to bottom and automatically replaces the first occurrence of &&& with [EMV LINK]ORDER[EMV /LINK] (where ORDER is the mirror link order number).

Parameters

messageId string

ID of the message.

name string

Name of the URL.

Return

string The order number of the url.

addShareLink

Scans your message from top to bottom and automatically replaces the first occurrence of &&& with [EMV SHARE lang=xx] (where xx is the language identifier).

Parameters

messageId string

The ID of the message.

linkType bool

The link type, true for link, false for button.

buttonUrl string (optional)

The URL of the sharebutton.

language string (optional)

The language, possible values are: us, en, fr, de, nl, es, ru, sv, it, cn, tw, pt, br, da, ja, ko.

Return

bool

updateUrlByField

Update an URL by field.

Parameters

messageId string

ID of the message.

order int

Order of the URL.

field string

Field to update.

value mixed

Value to set.

Return

bool true if the update was successful.

deleteUrl

Delete an URL.

Parameters

messageId string

ID of the message.

order int

Order of the URL.

Return

bool true if the delete was successful.

getUrlByOrder

Get an URL by his order

Parameters

messageId string

ID of the message.

order int

Order of the URL.

Return

array The URL parameters.

segmentationCreateSegment

Creates a segment.

Parameters

name string

The name of the segment.

sampleType string

The portion of the segment uses, possible values are: ALL, PERCENT, FIX.

description string (optional)

The description of the segment.

sampleRate float (optional)

The percentage/number of members from the segment.

Return

string The ID of the created segment.

segmentationDeleteSegment

Delete a segment

Parameters

id string

The ID of the segment.

Return

bool true if successfull, false otherwise.

segmentationAddStringDemographicCriteriaByObj

Adds alphanumeric demographic criteria to a segment.

Parameters

stringDemographicCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddNumericDemographicCriteriaByObj

Adds numeric demographic criteria to a segment.

Parameters

numericDemographicCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddDateDemographicCriteriaByObj

Adds date demographic criteria to a segment.

Parameters

dateDemographicCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddCampaignActionCriteriaByObj

Adds campaign action criteria to a segment.

Parameters

actionCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddCampaignTrackableLinkCriteriaByObj

Adds campaign tracked link criteria to a segment.

Parameters

trackableLinkCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddSerieActionCriteriaByObj

Adds reflex campaign action criteria to a segment.

Parameters

actionCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddSerieTrackableLinkCriteriaByObj

Adds reflex campaign tracked link criteria to a segment.

Parameters

trackableLinkCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddSocialNetworkCriteriaByObj

Adds social criteria to a segment.

Parameters

socialNetworkCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddRecencyCriteriaByObj

Adds quick segment criteria to segment.

Parameters

recencyCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationAddDataMartCriteriaByObj

Adds DataMart criteria to a segment.

Parameters

dataMartCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationGetSegmentById

Retrieves a segment.

Parameters

id string

The ID of the segment.

Return

object

segmentationGetSegmentList

Retrieves a list of segments.

Parameters

page int

The current page.

itemsPerPage int

The number of items per page.

Return

array A list of segmentation objects.

segmentationGetSegmentCriterias

Get the criteria used in a segment.

Parameters

id string

The ID of the segment.

Return

array A segmentation object

segmentationGetPersoFragList

Retrieves a list of DataMart segments

Parameters

page int

The current page.

itemsPerPage int

The number of items per page.

Return

array

segmentationDeleteCriteria

Delete a criteria cell.

Parameters

id string

The ID of the segment.

orderCriteria int

The ofder or the criteria.

Return

bool true on success, false otherwise.

segmentationUpdateSegment

Updates a segment.

Parameters

id string

The ID of the segment.

name string

The name of the segment.

sampleType string

The portion of the segment uses, possible values are: ALL, PERCENT, FIX.

sampleRate float (optional)

The percentage/number of members from the segment.

Return

bool true on success, false otherwise

segmentationUpdateStringDemographicCriteriaByObj

Updates alphanumeric demographic criteria to a segment.

Parameters

stringDemographicCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateNumericDemographicCriteriaByObj

Updates numeric demographic criteria to a segment.

Parameters

numericDemographicCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateDateDemographicCriteriaByObj

Updates date demographic criteria to a segment.

Parameters

dateDemographicCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateCampaignActionCriteriaByObj

Updates campaign action criteria to a segment.

Parameters

actionCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateCampaignTrackableLinkCriteriaByObj

Updates campaign tracked link criteria to a segment.

Parameters

trackableLinkCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateSerieActionCriteriaByObj

Updates reflex campaign action criteria to a segment.

Parameters

actionCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateSerieTrackableLinkCriteriaByObj

Updates reflex campaign tracked link criteria to a segment.

Parameters

trackableLinkCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateSocialNetworkCriteriaByObj

Updates social criteria to a segment.

Parameters

socialNetworkCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateRecencyCriteriaByObj

Updates quick segment criteria to segment.

Parameters

recencyCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationUpdateDataMartCriteriaByObj

Updates DataMart criteria to a segment.

Parameters

dataMartCriteria array

The criteria object.

Return

bool true on success, false otherwise.

segmentationCount

Counts the total number of members in a segment (including duplicated members).

Parameters

id string

The ID of the segment.

Return

int The number of members.

segmentationDistinctCount

Counts the total number of distinct members in a segment (duplicate members are removed).

Parameters

id string

The ID of the segment.

Return

int The number of members.

createCampaign

Create a campaign.

Parameters

name string

Name of the campaign.

sendDate int

Date for the campaign to be scheduled.

messageId string

Id of the message to send.

mailingListId string

Id of the mailing list to be send the campaign to.

description string (optional)

The description.

notifProgress bool (optional)

Should you be notified of the progress of the campaign by email.

postClickTracking bool (optional)

Use post click tracking?

emaildedupfig bool (optional)

Deduplicate the mailing list?

Return

string The ID of the campaign.

createCampaignWithAnalytics

Create a campaign with analytics activated.

Parameters

name string

Name of the campaign.

sendDate int

Date for the campaign to be scheduled.

messageId string

Id of the message to send.

mailingListId string

Id of the mailing list to be send the campaign to.

description string (optional)

The description.

notifProgress bool (optional)

Should you be notified of the progress of the campaign by email.

postClickTracking bool (optional)

Use post click tracking?

emaildedupfig bool (optional)

Deduplicate the mailing list?

Return

string The ID of the campaign.

createCampaignByObj

Create a campaign.

Parameters

campaign array

The campaign object.

Return

string The ID of the campaign.

deleteCampaign

Delete a campaign.

Parameters

id string

The ID of the campaign.

Return

bool true if delete was successful.

updateCampaign

Update a campaign.

Parameters

id string

The ID of the campaign.

field string

Field to update.

value mixed

Value to set.

Return

bool true of update was successful.

updateCampaignByObj

Update a campaign.

Parameters

campaign array

The campaign object.

Return

bool true if the update was successful.

postCampaign

Post a campaign.

Parameters

id string

The ID of the campaign.

Return

bool true if post was successful.

unpostCampaign

Unpost a campaign.

Parameters

id string

The ID of the campaign.

Return

bool true if unpost was successful.

getCampaign

Get a campign.

Parameters

id string

The ID of the campaign.

Return

object The campaign parameters.

getCampaignsByField

Get campaigns by field.

Parameters

field string

Field to update.

value mixed

Value to set in that field.

limit int

Maximum number of elements to retrieve.

Return

array List of IDS of campaigns matching the search.

getCampaignsByStatus

Retrieves a list of campaign having a specified status

Parameters

status string

Status to match, possible values: EDITABLE, QUEUED, RUNNING, PAUSES, COMPLETED, FAILED, KILLED.

Return

array The list of campaign IDs matching the status.

getCampaignsByPeriod

Retrieves a list of campaigns from a specific period.

Parameters

dateBegin int

The start date of the period.

dateEnd int

The end date of the period.

Return

array The list of campaign IDs matching the status.

getCampaignStatus

Get the status for a campaign.

Parameters

id string

The ID of the campaign.

Return

string Status of the campaign.

getLastCampaigns

Get last campaigns

Parameters

limit int

Maximum number of campaigns to retrieve.

Return

array

testCampaignByGroup

Sends a test campaign to a group of members.

Parameters

id string

The ID of the campaign.

groupId string

The ID of the group to whom to send the test.

Return

bool true if it was successfull, false otherwise.

testCampaignByMember

Sends a test campaign to a member.

Parameters

id string

The ID of the campaign.

memberId string

The ID of the member to whom to send the test.

Return

bool true if it was successfull, false otherwise.

pauseCampaign

Pause a running campaign.

Parameters

id string

The ID of the campaign.

Return

bool true if it was successfull, false otherwise.

unpauseCampaign

Unpauses a paused campaign.

Parameters

id string

The ID of the campaign.

Return

bool true if it was successfull, false otherwise.

getCampaignSnapshotReport

Retrieves a snapshot report.

Parameters

id string

The id of the campaign.

Return

array The report data.

createBanner

Creates a banner.

Parameters

name string

The name of the banner.

contentType string

The content type of the banner, possible values are: TEXT or HTML.

description string (optional)

The description.

content string (optional)

The content of the banner.

Return

string The ID of the banner.

createBannerByObj

Creates a banner.

Parameters

banner array

The banner.

Return

string The ID of the banner.

deleteBanner

Deletes a banner

Parameters

id string

The ID of the banner.

Return

bool true on success, false otherwise.

updateBanner

Updates a banner by field and value.

Parameters

id string

The ID of the banner.

field string

The field.

value mixed (optional)

The new value.

Return

bool true on success, false otherwise.

updateBannerByObj

Updates a banner.

Parameters

banner array

The banner.

Return

bool true on success, false otherwise.

cloneBanner

Clones a banner.

Parameters

id string

The ID of the banner.

name string

The new name of the banner.

Return

string The ID of the new banner.

getBannerPreview

Displays a preview of a banner.

Parameters

id string

The ID of the banner.

Return

string The formatted preview of a banner.

getBanner

Retrieves a banner.

Parameters

id string

The ID of the banner.

Return

object The banner

getBannersByField

Retrieves a list of banners that contain the given value in a field.

Parameters

field string

The field of the banner.

value mixed (optional)

The value.

limit int

The size of the list (between 1 and 1000).

Return

array The IDs of the banners.

getBannersByPeriod

Retrieves a list of banners from a given period.

Parameters

dateStart int

The start date of the period.

dateEnd int

The end date of the period.

Return

array The IDs of the banners.

getLastBanners

Retrieves the list of the last banners.

Parameters

limit int

The size of the list (between 1 and 1000).

Return

array The IDs of the banners.

trackAllBannerLinks

Activates tracking for all untracked banner links and saves the banner.

Parameters

id string

The ID of the banner.

Return

int The last tracked link's order.

untrackAllBannerLinks

untracks all the banner links.

Parameters

id string

The ID of the banner.

Return

int The last tracked link's order.

trackBannerLinkByPosition

Tracks the banner link through its position

Parameters

id string

The ID of the banner.

position int

The position of the link in the banner.

Return

int The order number of the url.

untrackBannerLinkByOrder

Untracks a link in the banner by its order.

Parameters

id string

The ID od the banner.

order int

The order number of the url.

Return

bool true on success, false otherwise.

getAllBannerTrackedLinks

Retrieves a list of all the tracked links in a banner.

Parameters

id string

The ID of the banner.

Return

array List of the tracked links.

getAllUnusedBannerTrackedLinks

Retrieves a list of all the unused tracked links in a banner.

Parameters

id string

The ID of the banner.

Return

array List of the unused tracked links.

getAllBannerTrackableLinks

Retrieves a list of all the trackable links in a banner.

Parameters

id string

The ID of the banner.

Return

array List of the trackable links.

createStandardBannerLink

Creates a standard link for the banner.

Parameters

id string

The ID of the banner.

name string

The name of the banner.

url string

The url of the link.

Return

int The order number of the url.

createAndAddStandardBannerLink

Creates and adss standard link to the banner.

Parameters

id string

The ID of the banner.

name string

The name of the banner.

url string

The url of the link.

Return

int The order number of the url.

createUnsubscribeBannerLink

Creates an unsubscribe link for the banner.

Parameters

id string

ID of the banner.

name string

Name of the URL.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string Order number of the URL.

createAndAddUnsubscribeBannerLink

Creates and adds an unsubscribe link for the banner.

Parameters

id string

ID of the banner.

name string

Name of the URL.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string Order number of the URL.

createPersonalisedBannerLink

Creates a personalized link to the banner.

Parameters

id string

The ID of the banner.

name string

The name of the banner.

url string

The url of the link.

Return

int The order number of the url.

createAndAddPersonalisedBannerLink

Creates and adds personalized link to the banner.

Parameters

id string

The ID of the banner.

name string

The name of the banner.

url string

The url of the link.

Return

int The order number of the url.

createUpdateBannerLink

Creates an update link for the banner.

Parameters

id string

ID of the banner.

name string

Name of the URL.

parameters mixed

The updateparameters to apply to the member.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string Order number of the URL.

createAndAddUpdateBannerLink

Creates and adds an update link for the banner.

Parameters

id string

ID of the banner.

name string

Name of the URL.

parameters mixed

The updateparameters to apply to the member.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string Order number of the URL.

createActionBannerLink

Creates and adds an action link for the banner.

Parameters

id string

ID of the banner.

name string

Name of the URL.

action string

The action to perform.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string Order number of the URL.

createAndAddActionBannerLink

Creates and adds an action link for the banner.

Parameters

id string

ID of the banner.

name string

Name of the URL.

action string

The action to perform.

pageOk string (optional)

URL to call when unsubscribe was successful.

messageOk string (optional)

Message to display when unsubscribe was successful.

pageError string (optional)

URL to call when unsubscribe was unsuccessful.

messageError string (optional)

Message to display when unsubscribe was unsuccessful.

Return

string Order number of the URL.

createMirrorBannerLink

Creates a mirror link in the banner.

Parameters

id string

The id of the banner.

name string

The name of the link.

Return

int The order number of the url.

createAndAddMirrorBannerLink

Creates and adds a mirror link in the banner.

Parameters

id string

The id of the banner.

name string

The name of the link.

Return

int The order number of the url.

updateBannerLinkByField

Updates a banner link by field.

Parameters

id string

The ID of the banner.

order int

The ordernumber of the url.

field string

The field.

value mixed (optional)

The new value.

Return

bool true on success, false otherwise.

getBannerLinkByOrder

Retrieves a banner link by its order number.

Parameters

id string

The ID of the banner.

order int

The order number.

Return

array

createTestGroup

Creates a test group of members.

Parameters

name string

The name of the test group.

Return

string The ID of the newly created test group.

createTestGroupByObj

Creates a test group.

Parameters

testGroup array

The test group object.

Return

string The ID of the created test group.

addTestMember

Adds a member to a test group.

Parameters

memberId string

The ID of the member to add.

groupId string

The ID of the group to which to add the member.

Return

bool true if it was successfull, false otherwise.

removeTestMember

Removes a member from a test group

Parameters

memberId string

The ID of the member to add.

groupId string

The ID of the group to which to add the member.

Return

bool true if it was successfull, false otherwise.

deleteTestGroup

Deletes a test group.

Parameters

groupId string

The ID of the group to which to add the member.

Return

bool true if it was successfull, false otherwise.

updateTestGroupByObj

Updates a test group.

Parameters

testGroup array

The test group object.

Return

bool true if it was successfull, false otherwise.

getTestGroup

Retrieves the list of members in a test group.

Parameters

groupId string

The ID fo the group.

Return

object The list of member ID's in that group

getClientTestGroups

Retrieves a list of test groups.

Return

array The list of groups IDs.