API Documentation
\
MoxiworksPlatform
Exception

\MoxiworksPlatformEmailCampaign

Summary

Methods
Properties
Constants
headers()
authHeader()
acceptHeader()
contentTypeHeader()
userAgentHeader()
apiConnection()
checkForErrorInResponse()
underscore()
search()
$moxi_works_agent_id
$partner_contact_id
$subscription_type
$email_address
$subscribed_at
$area
$last_sent
$next_scheduled
No constants found
No protected methods found
No protected properties found
N/A
No private methods found
No private properties found
N/A

Properties

$moxi_works_agent_id

$moxi_works_agent_id : string

Type

string — the Moxi Works Platform ID of the agent moxi_works_agent_id is the Moxi Works Platform ID of the agent which a campaign is or is to be associated with. this must be set for any Moxi Works Platform transaction

$partner_contact_id

$partner_contact_id : string

Type

string — your system's unique ID for the contact *your system's* unique ID for the Contact associated with this campaign this must be set for any Moxi Works Platform transaction

$subscription_type

$subscription_type : string

Type

string — the type of this email campaign

$email_address

$email_address : string

Type

string — the email address used for this campaign

$subscribed_at

$subscribed_at : integer

Type

integer — the Unix timestamp representing the date/time that this subscription was created

$area

$area : string

Type

string — the area that this email campaign regards. This will likely be a zip code, but allow for arbitrary human readable strings referencing geographical locations.

$last_sent

$last_sent : integer

Type

integer — the Unix timestamp representing the date/time that the last email message for this campaign was sent. If no email has been sent for this campaign, the value will be 0

$next_scheduled

$next_scheduled : integer

Type

integer — the Unix timestamp representing the date/time that the next email message for this campaign will be sent. If no email is scheduled to be sent for this campaign, the value will be 0

Methods

headers()

headers()

authHeader()

authHeader()

acceptHeader()

acceptHeader()

contentTypeHeader()

contentTypeHeader()

userAgentHeader()

userAgentHeader()

apiConnection()

apiConnection(  $method,   $url,   $attributes)

Parameters

$method
$url
$attributes

checkForErrorInResponse()

checkForErrorInResponse(  $json)

Parameters

$json

underscore()

underscore(  $attr)

Parameters

$attr

search()

search(array  $attributes = array()) : Array

Search for EmailCampaign on Moxi Works Platform.

\MoxiworksPlatform\Contact::search([moxi_works_agent_id: 'abc123', partner_contact_id: 'MySystemContactID'])

Parameters

array $attributes


moxi_works_agent_id REQUIRED The Moxi Works Agent ID for the agent to which this contact is to be associated
partner_contact_id REQUIRED your system's ID for a specific contact for whom email campaigns are to be returned

Throws

\MoxiworksPlatform\Exception\ArgumentException

if required parameters are not included

\MoxiworksPlatform\Exception\ArgumentException

if at least one search parameter is not defined

\MoxiworksPlatform\RemoteRequestFailureException

Returns

Array —

of EmailCampaign objects