This module allows you to manage and create Identities associated with the Newsletter feature.

add

Create a new Identity.

Parameters

Parameter Required Requirements Description
identity Yes None Create an Identity named this.
name Yes None Specify the name to be used for this Identity.
email Yes None Specify the email address to be used for this Identity.
address Yes None Specify the physical address to be used for this Identity.
city Yes None Specify the city to be used for this Identity.
state Yes None Specify the state code to be used for this Identity.
zip Yes None Specify the zip code to be used for this Identity.
country Yes None Specify the country code to be used for this Identity.

edit

Edit an new Identity.

Parameters

Parameter Required Requirements Description
identity Yes Must be an existing Identity. The Identity you wish to edit.
newidentity No None Specify the new name to be used for this Identity.
name No None Specify the new name to be used for this Identity.
email No None Specify the new email address to be used for this Identity.
address No None Specify the new physical address to be used for this Identity.
city No None Specify the new city to be used for this Identity.
state No None Specify the new state code to be used for this Identity.
zip No None Specify the new zip code to be used for this Identity.
country No None Specify the new country code to be used for this Identity.

get

Retrieve information associated with a particular Identity.

Parameters

Parameter Required Requirements Description
identity Yes Must be an existing Identity. Retrieve contents of the specified Identity.

list

List all Identities on your account, or check if a particular Identity exists.

Parameters

Parameter Required Requirements Description
identity No Must be an existing Identity. Check for this particular Identity. (To list all Identities on your account exclude this parameter)

delete

Remove an Identity from your account.

Parameters

Parameter Required Requirements Description
identity Yes Must be an existing Identity. Remove the specified Identity from your account.