Get your message out! ™
Click to Chat
LoadingLoading Page, Please wait

API v2 Documentation

The API provides a way to integrate your system with ours, keeping all your data in sync. It allows you to retrieve and manipulate your data just as you can on the web site but without the fancy interface.

Actions

The API is comprised of many individual actions. Each API request must specify an action using the action parameter. To see a complete list of the actions, go to the Actions tab. Action names start with a prefix that indicates the type of data involved, which can help you find the action you want.

Accessing the API

You can access the API using standard web protocols. API requests are made using either HTTP GET or HTTP POST.

The API is located at the following URL:

https://api.firedrummarketing.com/api/v2.jsp

A typical API request using HTTP GET looks like the following:

https://api.firedrummarketing.com/api/v2.jsp?action=<ActionName>&authAPIKey=<YourAPIKey>&paramN=<ValueN>

Parameters

The API parameters are extracted from the query parameters of an HTTP GET or from the request body of an HTTP POST. There is a special, optional parameter — params — that can be a JSON object containing parameters. The parameters in the params object will be overriden by any parameters of the same name in the query string or request body.

Arrays

Parameters whose names end with [] support multiple values (arrays).

Some JSON frameworks, such as JSON.NET, might have problems mapping parameters with brackets in the name to object properties. To work around this limitation, name your object properties with a suffix like "_Array" in place of the square brackets. Then after serializing the object for the request, or before deserializing the response, swap our your suffix for the square brackets.

Authentication

There are three different types of authentication used in the API — API Key, username and password, and none.

API Key

To access the majority of the API, you will need an API key. You can get a key and manage your keys using the API itself, but the easiest way to get a key is by using the API Key panel in your Configure Account page. Provide your API key using the authAPIKey parameter. Here's an example API request URL that uses an API Key:

https://api.firedrummarketing.com/api/v2.jsp?action=Category_Add&authAPIKey=1234567890abcdef&name=New+Category&sortSequence=3&publicDisplay=true

Username/Password

Actions that retrieve or manipulate your API Keys require username and password for authentication instead of an API key. Here's an example API request URL that uses username and password:

https://api.firedrummarketing.com/api/v2.jsp?action=APIKey_List&username=scott&password=tiger

None

There are a couple of actions that provide public information and do not require authentication. Here's an example API request URL that requires no authentication:

https://api.firedrummarketing.com/api/v2.jsp?action=API_ActionSchemas

Response

The API responses are always in JSON (JavaScript Object Notation) format. JSON can represent complex data structures yet still be easily readable by humans, which is handy for debugging. The response is a JSON object comprised of three things — the properties unique to each action, the response code, and the echoed request parameters.

Response Code

A response always includes a response code object under the responseCode property. The response code object has two properties — id and name. The response code indicates whether the request was successful or encountered errors. Response code ID 0 indicates success. All other response codes indicate an error condition.

To see the full list of response codes, go to the Response Codes tab.

Parameter Echo

Under the params property, a response includes a copy of the parameters given in the request. This can be useful for debugging, but it can also be convenient when handling the responses.

Pretty Output

A response does not normally include any unnecessary whitespace. This can be difficult to read, however, when you need to do testing or debugging. To have the API return its responses with structural whitespace, add the prettyOutput=true parameter to any request. Here's an example using pretty output:

https://api.firedrummarketing.com/api/v2.jsp?action=API_ActionSchemas&prettyOutput=true

Time Zones

Some parameters in a requested action, as well as some data fields in the response, are made up of a date and time. The format for these request parameters is listed in the schema as "dateTime".

The time zone for all input DateTimes and output DateTimes will be in the time zone associated with the account of the authenticating API key, unless the "useUTC" parameter is set to true.

The "useUTC" parameter is an optional boolean parameter that can be provided for any requested action. The "useUTC" parameter defaults to false. When the "useUTC" parameter is true, the time zone for all input DateTimes and output DateTimes will be UTC.

For example:

https://api.firedrummarketing.com/api/v2.jsp?action=APIKey_List&username=scott&password=tiger&useUTC=true

Parameters and fields that are dates without a time portion are not affected by time zones or the "useUTC" parameter.

API Changes

There are times when we need to make changes to the API. These changes come in 3 forms:

  • New Actions - Actions will be added to expand the capabilities of the API. These additions will not affect your existing use of the API.
  • Additions to an Existing Action - When possible, any changes to an existing Action will be done as additional, optional parameters. The defaults to the new parameters will be implemented in such a way that any existing use of the API will not break or have significant, unreasonable behavior changes.
  • Changes to an Existing Action - In cases where changes are necessary to the parameters or behavior of an existing Action, we will try to provide these as new versions of the API when possible. If the change must be made to an existing version of the API, then we will try to provide API users with as much advance notice as possible so that they can adjust their integration code if necessary.

Assistance

While we strive to make the API easy to understand and use, it does still require some technical skill, so if you don't have a programmer available, please contact us for a quote on API integration assistance.

To view this information in JSON schema-based format, please see the raw schema.

Action Name Filter:

APIKey_Add

Add an API key

Parameters

Name Type Rules Description
label string
  • maxLength : 255
  • optional : true
userId integer
  • minimum : 1
  • optional : true
Adds an API key. Requires authUsername and authPassword parameters instead of authAPIKey.

APIKey_Expire

Expire an API key

Parameters

Name Type Rules Description
apiKey string
  • pattern : [a-zA-z0-9]{16}
Expires an API key. Requires authUsername and authPassword parameters instead of authAPIKey.

APIKey_List

List API keys

Parameters

Name Type Rules Description
userId integer
  • minimum : 1
  • optional : true
Lists all API keys. Requires authUsername and authPassword parameters instead of authAPIKey.

APIKey_Rename

Rename API key

Parameters

Name Type Rules Description
apiKey string
  • pattern : [a-zA-z0-9]{16}
label string
  • maxLength : 255
Renames an API key. Requires authUsername and authPassword parameters instead of authAPIKey.

API_ActionSchemas

Retrieve the API action schemas

Parameters

None

Retrieves the API action schemas. This is derived from the raw content located at /js/api/v2.js .

API_Documentation

Retrieve the API documentation

Parameters

None

Retrieves the API documentation. This is derived from the raw content located at /js/api/v2.js .

API_ResponseCodes

Retrieve the API response codes

Parameters

None

Retrieves the API response codes.

Campaign_Add

Add a campaign

Parameters

Name Type Rules Description
abEnabled boolean
  • default : false
  • optional : true
Indicates whether A/B testing is enabled. Only applies when campaign type is normal.
activate boolean
  • default : false
  • optional : true
Only applies when campaign type is triggered, birthday, anniversary, or date.
authentication boolean
  • default : false
  • optional : true
autoSender boolean
  • default : false
  • optional : true
Only applies when campaign type is normal.
autoSenderCategoryId[] array
  • optional : true
Only applies when campaign type is normal.

Item Rules

Type Rules
integer
  • minimum : 1
customFieldId integer
  • minimum : 1
  • optional : true
Only applies when campaign type is date.
googleAnalytics boolean
  • default : false
  • optional : true
name string
  • maxLength : 255
publicDisplay boolean
  • default : false
  • optional : true
sendingDelayDays integer
  • default : 0
  • minimum : 0
  • optional : true
sendingDelayMinutes integer
  • default : 0
  • minimum : 0
  • optional : true
sendingLeadDays integer
  • default : 0
  • minimum : 0
  • optional : true
Only applies when campaign type is birthday, anniversary, or date. Indicates the number of days before the event that the campaign will be sent. For date type, if the when is set to after, then this will be the number of days after the event.
trigger object
  • optional : true
  • properties : {"issueNumber[]":{"description":"This does not apply if the triggering campaign specified by campaignId is a triggered email.","optional":true,"type":"array","items":{"optional":true,"type":"integer","minimum":1}},"campaignId":{"description":"Only applies when campaign type is triggered. Required regardless of activation.","type":"integer","minimum":1},"issueNumberGreaterThanEquals":{"default":0,"description":"Apply triggers to all issues with this number or greater. Zero disables this option. This does not apply if the triggering campaign specified by campaignId is a triggered email.","optional":true,"type":"integer","minimum":0},"type":{"default":"click","description":"Only applies when campaign type is triggered.","optional":true,"type":"string","enum":["click","open"]},"click":{"description":"Only applies when trigger type is click.","optional":true,"type":"object","properties":{"rule[]":{"minItems":1,"description":"Only applies when trigger linkType is rule.","optional":true,"type":"array","items":{"type":"object","properties":{"comparisonOperator":{"type":"string","enum":["contains","notContains","exact","notExact","starts","ends","pattern","notPattern"]},"pattern":{"minLength":1,"type":"string"}}}},"url[]":{"minItems":1,"description":"Only applies when trigger linkType is url.","optional":true,"type":"array","items":{"minLength":1,"type":"string"}},"linkType":{"optional":true,"type":"string","enum":["all","url","rule"]},"ruleLogicalOperator":{"description":"Only applies when trigger linkType is rule.","optional":true,"type":"string","enum":["and","or"]}}}}
Only applies when campaign type is triggered. Most trigger settings are only required when activating.
type string
  • enum : ["normal", "triggered", "birthday", "anniversary", "date"]
userId integer
  • minimum : 1
  • optional : true
when string
  • enum : ["before", "on", "after"]
  • optional : true
Only applies when campaign type is date.
Adds a campaign.

Campaign_Delete

Delete a campaign

Parameters

Name Type Rules Description
id integer
  • minimum : 1
Deletes a campaign. This action is only available to the admin user.

Campaign_List

List campaigns

Parameters

Name Type Rules Description
id integer
  • minimum : 1
  • optional : true
id[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
publishedIssuesCount integer
  • default : -1
  • optional : true
The number of published issues to include, starting with publishedIssuesStart. The count always go up in issue numbers, so if you want the 3 most recent issues, specify a publishedIssuesStart of -3 and a publishedIssuesCount of 3. Set to 0 to not include any issues. Set to a negative value to be open-ended.
publishedIssuesStart integer
  • default : 0
  • optional : true
Include a list of published issues for the campaign in the returned object, starting with this issue number (1-based). Set to 0 to not include any issues. A positive number will be based at the beginning of the issue numbers. A negative number will go backwards from the most recent issue number, so -1 will be the most recent, -2 the next most recent, etc.
userId integer
  • minimum : 1
  • optional : true
Lists campaigns.

Campaign_Send

Send a published campaign to an individual member

Parameters

Name Type Rules Description
campaignId integer
  • minimum : 1
deliveryDate string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
When to send the message. If deliveryDate is specified, then deliveryDateDelayDays and deliveryDateDelayMinutes are ignored.
deliveryDateDelayDays integer
  • minimum : 0
  • optional : true
The number of minutes to delay the sending.
deliveryDateDelayMinutes integer
  • minimum : 0
  • optional : true
The number of minutes to delay the sending.
errorOnPastDeliveryDate boolean
  • optional : true
If set to the true, then a past delivery date will cause the API to return an error. If set to false or not provided, then a past delivery date will be treated as the current time.
issueNumber integer
  • minimum : 1
  • optional : true
If this is not provided, then the most recently published recent issue in the campaign will be used.
memberEmail string
  • format : email
  • maxLength : 64
  • minLength : 1
  • optional : true
Identifies the member to send to. Either memberId or memberEmail must be provided to identify the member.
memberId integer
  • minimum : 1
  • optional : true
Identifies the member to send to. Either memberId or memberEmail must be provided to identify the member.
Schedules a single sending of an existing campaign issue to a member. The sending can be immediate or delayed. The member can be identified by either memberId or memberEmail.

Campaign_Update

Update campaign settings

Parameters

Name Type Rules Description
abEnabled boolean
  • optional : true
Indicates whether A/B testing is enabled. Only applies when campaign type is normal.
activate boolean
  • default : false
  • optional : true
Only applies when campaign type is triggered, birthday, anniversary, or welcome.
authentication boolean
  • optional : true
autoSender boolean
  • default : false
  • optional : true
Only applies when campaign type is normal.
autoSenderCategoryId[] array
  • optional : true
Only applies when campaign type is normal.

Item Rules

Type Rules
integer
  • minimum : 1
customFieldId integer
  • minimum : 1
  • optional : true
Only applies when campaign type is date.
googleAnalytics boolean
  • optional : true
id integer
  • minimum : 1
name string
  • maxLength : 255
publicDisplay boolean
  • optional : true
sendingDelayDays integer
  • minimum : 0
  • optional : true
Only applies when campaign type is normal.
sendingDelayMinutes integer
  • minimum : 0
  • optional : true
Only applies when campaign type is normal.
sendingLeadDays integer
  • minimum : 0
  • optional : true
Only applies when campaign type is birthday, anniversary, or welcome.
trigger object
  • optional : true
  • properties : {"issueNumber[]":{"optional":true,"type":"array","items":{"optional":true,"type":"integer","minimum":1}},"issueNumberGreaterThanEquals":{"default":0,"description":"Apply triggers to all issues with this number or greater. Zero disables this option.","optional":true,"type":"integer","minimum":0},"type":{"default":"click","description":"Only applies when campaign type is triggered.","optional":true,"type":"string","enum":["click","open"]},"click":{"description":"Only applies when trigger type is click.","optional":true,"type":"object","properties":{"rule[]":{"minItems":1,"description":"Only applies when trigger linkType is rule.","optional":true,"type":"array","items":{"type":"object","properties":{"comparisonOperator":{"type":"string","enum":["contains","notContains","exact","notExact","starts","ends","pattern","notPattern"]},"pattern":{"minLength":1,"type":"string"}}}},"url[]":{"minItems":1,"description":"Only applies when trigger linkType is url.","optional":true,"type":"array","items":{"minLength":1,"type":"string"}},"linkType":{"optional":true,"type":"string","enum":["all","url","rule"]},"ruleLogicalOperator":{"description":"Only applies when trigger linkType is rule.","optional":true,"type":"string","enum":["and","or"]}}}}
Only applies when campaign type is triggered. Most trigger settings are only required when activating.
when string
  • enum : ["before", "on", "after"]
  • optional : true
Only applies when campaign type is date.
Updates the settings of a campaign.

Category_Add

Add a category

Parameters

Name Type Rules Description
excludeCategoryId[] array
  • optional : true

Item Rules

Type Rules
integer None
includeCategoryId[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
name string
  • maxLength : 255
  • minLength : 1
publicDisplay boolean
  • default : false
  • optional : true
sortSequence integer
  • default : 1
  • minimum : 1
  • optional : true
userId integer
  • minimum : 1
  • optional : true
Adds a category.

Category_Delete

Delete a category

Parameters

Name Type Rules Description
id integer
  • minimum : 1
orphanCategoryId integer
  • minimum : 1
  • optional : true
Deletes a category.

Category_List

List categories

Parameters

Name Type Rules Description
id[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
includeMemberCount boolean
  • default : false
  • optional : true
limit integer
  • default : 100
  • maximum : 1000
  • minimum : 0
  • optional : true
sortBy string
  • enum : ["id", "userId", "name", "publicDisplay", "sortSequence"]
  • optional : true
sortOrder string
  • enum : ["asc", "desc"]
  • optional : true
start integer
  • default : 0
  • minimum : 0
  • optional : true
This is a 0-based index.
userId integer
  • minimum : 1
  • optional : true
Lists categories.

Category_Merge

Merge members from one or more categories into another

Parameters

Name Type Rules Description
destinationCategoryId integer
  • minimum : 1
operation string
  • enum : ["move", "copy"]
sourceCategoryId[] array None

Item Rules

Type Rules
integer
  • minimum : 1
Moves or copies members who are in one or more source categories into a destination category.

Category_Orphan_Count

Count members that are only in this category

Parameters

Name Type Rules Description
categoryId integer
  • minimum : 1
Counts the members that are only in this category.

Category_Orphan_List

List members that are only in this category

Parameters

Name Type Rules Description
categoryId integer
  • minimum : 1
Lists the IDs of members that are only in this category.

Category_Update

Update a category

Parameters

Name Type Rules Description
id integer
  • minimum : 1
name string
  • maxLength : 255
  • minLength : 1
publicDisplay boolean
  • default : false
  • optional : true
sortSequence integer
  • default : 1
  • minimum : 1
  • optional : true
Updates a category.

CustomField_Add

Add a custom field

Parameters

Name Type Rules Description
dataType string
  • default : text
  • enum : ["text", "date", "radio", "select"]
  • optional : true
label string
  • maxLength : 255
  • minLength : 1
option[] array
  • minItems : 2
  • optional : true
Only applies when dataType is radio or select.

Item Rules

Type Rules
string
  • minLength : 1
publicDisplay boolean
  • default : false
  • optional : true
userId integer
  • minimum : 1
  • optional : true
Adds a custom field.

CustomField_Delete

Delete a custom field

Parameters

Name Type Rules Description
id integer
  • minimum : 1
Deletes a custom field.

CustomField_List

List custom fields

Parameters

Name Type Rules Description
id integer
  • minimum : 1
  • optional : true
userId integer
  • minimum : 1
  • optional : true
Lists custom fields.

CustomField_Update

Update a custom field

Parameters

Name Type Rules Description
dataType string
  • default : text
  • enum : ["text", "date", "radio", "select"]
  • optional : true
id integer
  • minimum : 1
  • optional : true
label string
  • maxLength : 255
  • minLength : 1
option[] array
  • minItems : 2
  • optional : true
Only applies when dataType is radio or select.

Item Rules

Type Rules
string
  • minLength : 1
publicDisplay boolean
  • default : false
  • optional : true
Updates a custom field.

Member_Add

Add a member

Parameters

Name Type Rules Description
address string
  • maxLength : 255
  • optional : true
address2 string
  • maxLength : 64
  • optional : true
anniversaryDate string
  • optional : true
  • pattern : (\d{4}-)?\d{2}-\d{2}
This is not affected by useUTC.
birthDate string
  • optional : true
  • pattern : (\d{4}-)?\d{2}-\d{2}
This is not affected by useUTC.
categoryId[] array None

Item Rules

Type Rules
integer
  • minimum : 1
city string
  • maxLength : 64
  • optional : true
company string
  • maxLength : 255
  • optional : true
customField[] array
  • optional : true

Item Rules

Type Rules
object See Item Properties below

Item Properties

Name Type Rules Description
id integer
  • minimum : 1
  • optional : true
Either id or name must be specified.
name string
  • maxLength : 255
  • minLength : 1
  • optional : true
Either id or name must be specified.
value string
  • maxLength : 255
  • minLength : 0
If type is date, then use pattern (\d{4}-)?\d{2}-\d{2}
email string
  • format : email
  • maxLength : 64
  • minLength : 1
fax string
  • maxLength : 64
  • optional : true
firstName string
  • maxLength : 64
  • optional : true
gender string
  • maxLength : 64
  • optional : true
lastName string
  • maxLength : 64
  • optional : true
mobilePhone string
  • maxLength : 64
  • optional : true
phone string
  • maxLength : 64
  • optional : true
replaceCategories string
  • default : none
  • enum : ["none", "publicOnly", "except", "all"]
  • optional : true
replaceCustomFieldData boolean
  • default : false
  • optional : true
skipCaptcha boolean
  • default : false
  • optional : true
state string
  • maxLength : 64
  • optional : true
triggerAutoSenders boolean
  • default : true
  • optional : true
Indicates whether auto senders will be triggered for categories that were added to the member.
updateIfExists boolean
  • default : false
  • optional : true
userId integer
  • minimum : 1
  • optional : true
zip string
  • maxLength : 64
  • optional : true
Adds a member.

Member_Count

Count members

Parameters

Name Type Rules Description
address string
  • maxLength : 255
  • optional : true
address2 string
  • maxLength : 64
  • optional : true
anniversaryDate string
  • format : date
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2}
bestClickTimeGreaterThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestClickTimeGreaterThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestClickTimeLessThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestClickTimeLessThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeGreaterThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeGreaterThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeLessThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeLessThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
birthDate string
  • format : date
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2}
bouncesTotal integer
  • minimum : 0
  • optional : true
bouncesTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if bouncesTotal is defined. Defaults to equal.
categoryId[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
city string
  • maxLength : 64
  • optional : true
city[] array
  • optional : true
If city is also defined, it will be combined with these values. Boolean OR logic is used for multiple values.

Item Rules

Type Rules
string
  • minimum : 1
clicksTotal integer
  • minimum : 0
  • optional : true
clicksTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if clicksTotal is defined. Defaults to equal.
company string
  • maxLength : 255
  • optional : true
customFieldValue[] array
  • optional : true

Item Rules

Type Rules
string
  • maxLength : 255
email string
  • format : email
  • maxLength : 64
  • optional : true
enrollDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
enrollDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
enrollDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
enrollDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
fax string
  • maxLength : 64
  • optional : true
firstName string
  • maxLength : 64
  • optional : true
gender string
  • maxLength : 64
  • optional : true
includeSubUsers boolean
  • default : false
  • optional : true
lastModifiedDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastModifiedDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastModifiedDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastModifiedDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastName string
  • maxLength : 64
  • optional : true
lastSentDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastSentDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastSentDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastSentDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
mobilePhone string
  • maxLength : 64
  • optional : true
opensTotal integer
  • minimum : 0
  • optional : true
opensTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if opensTotal is defined. Defaults to equal.
optOutDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
optOutDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
optOutDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
optOutDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
partialEmail string
  • maxLength : 64
  • optional : true
phone string
  • maxLength : 64
  • optional : true
sentTotal integer
  • minimum : 0
  • optional : true
sentTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if sentTotal is defined. Defaults to equal.
state string
  • maxLength : 64
  • optional : true
state[] array
  • optional : true
If state is also defined, it will be combined with these values. Boolean OR logic is used for multiple values.

Item Rules

Type Rules
string
  • minimum : 1
status string
  • enum : ["active", "deactivated", "all"]
  • optional : true
userId integer
  • minimum : 1
  • optional : true
zip string
  • maxLength : 64
  • optional : true
A value less than 5 characters is considered a prefix for wildcard matching. Asterisks can also be used for wilcard matching
zip[] array
  • optional : true
If zip is also defined, it will be combined with these values. Boolean OR logic is used for multiple values. Values less than 5 characters are considered prefixes for wildcard matching. Asterisks can also be used for wilcard matching.

Item Rules

Type Rules
string
  • minimum : 1
Counts members.

Member_List

List members

Parameters

Name Type Rules Description
address string
  • maxLength : 255
  • optional : true
address2 string
  • maxLength : 64
  • optional : true
anniversaryDate string
  • format : date
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2}
This is not affected by useUTC.
bestClickTimeGreaterThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestClickTimeGreaterThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestClickTimeLessThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestClickTimeLessThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeGreaterThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeGreaterThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeLessThan string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
bestOpenTimeLessThanEquals string
  • format : time
  • optional : true
  • pattern : \d{2}:\d{2}:\d{2}
This should be in 24-hour time format in the API user's time zone.
birthDate string
  • format : date
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2}
This is not affected by useUTC.
bouncesTotal integer
  • minimum : 0
  • optional : true
bouncesTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if bouncesTotal is defined. Defaults to equal.
categoryId[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
city string
  • maxLength : 64
  • optional : true
city[] array
  • optional : true
If city is also defined, it will be combined with these values. Boolean OR logic is used for multiple values.

Item Rules

Type Rules
string
  • minimum : 1
clicksTotal integer
  • minimum : 0
  • optional : true
clicksTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if clicksTotal is defined. Defaults to equal.
company string
  • maxLength : 255
  • optional : true
customFieldValue[] array
  • optional : true
Filters based on the value of any custom field.

Item Rules

Type Rules
string
  • maxLength : 255
customField[] array
  • optional : true
Filters members based on the values of specific custom fields. A member must match all of the given items (i.e. an AND list).

Item Rules

Type Rules
object See Item Properties below

Item Properties

Name Type Rules Description
id integer
  • minimum : 1
  • optional : true
Either id or name must be specified.
name string
  • maxLength : 255
  • minLength : 1
  • optional : true
Either id or name must be specified.
value[] array
  • items : {"minLength":0,"type":"string","maxLength":255}
  • minItems : 1
Provides one or more accepted values for this custom field in order to match (i.e. an OR list).
email string
  • format : email
  • maxLength : 64
  • optional : true
engagementStatus string
  • enum : ["engaged", "unengaged", "all"]
  • optional : true
enrollDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
enrollDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
enrollDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
enrollDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
fax string
  • maxLength : 64
  • optional : true
firstName string
  • maxLength : 64
  • optional : true
gender string
  • maxLength : 64
  • optional : true
id integer
  • minimum : 1
  • optional : true
id[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
includeSubUsers boolean
  • default : false
  • optional : true
lastModifiedDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastModifiedDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastModifiedDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastModifiedDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastName string
  • maxLength : 64
  • optional : true
lastSentDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastSentDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastSentDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
lastSentDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
limit integer
  • default : 1000
  • maximum : 1000
  • minimum : 0
  • optional : true
mobilePhone string
  • maxLength : 64
  • optional : true
opensTotal integer
  • minimum : 0
  • optional : true
opensTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if opensTotal is defined. Defaults to equal.
optOutDateGreaterThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
optOutDateGreaterThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
optOutDateLessThan string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
optOutDateLessThanEquals string
  • format : dateTime
  • optional : true
  • pattern : \d{4}-\d{2}-\d{2} \d{2}:\d{2}:\d{2}
partialEmail string
  • maxLength : 64
  • optional : true
phone string
  • maxLength : 64
  • optional : true
sentTotal integer
  • minimum : 0
  • optional : true
sentTotalComparisonOperator string
  • enum : ["equal", "notEqual", "greaterThan", "greaterThanEqual", "lessThan", "lessThanEqual"]
  • optional : true
Only used if sentTotal is defined. Defaults to equal.
sortBy string
  • optional : true
Possible values are the standard fields of 'id', 'userId', 'firstName', 'lastName', 'email', 'birthDate', 'anniversaryDate', 'lastModifiedDate', 'enrollDate', 'optOutDate', 'lastSentDate', 'status'. You can also specify a custom field label.
sortOrder string
  • enum : ["asc", "desc"]
  • optional : true
start integer
  • default : 0
  • minimum : 0
  • optional : true
This is a 0-based index.
state string
  • maxLength : 64
  • optional : true
state[] array
  • optional : true
If state is also defined, it will be combined with these values. Boolean OR logic is used for multiple values.

Item Rules

Type Rules
string
  • minimum : 1
status string
  • enum : ["active", "deactivated", "all"]
  • optional : true
userId integer
  • minimum : 1
  • optional : true
zip string
  • maxLength : 64
  • optional : true
A value less than 5 characters is considered a prefix for wildcard matching. Asterisks can also be used for wilcard matching
zip[] array
  • optional : true
If zip is also defined, it will be combined with these values. Boolean OR logic is used for multiple values. Values less than 5 characters are considered prefixes for wildcard matching. Asterisks can also be used for wilcard matching.

Item Rules

Type Rules
string
  • minimum : 1
Lists members. The limit parameter defaults to and maxes out at 1000.

Member_RemoveFromCategory

Remove the member from the specified categories.

Parameters

Name Type Rules Description
categoryId[] array None

Item Rules

Type Rules
integer
  • minimum : 1
email string
  • format : email
  • maxLength : 64
  • minLength : 1
  • optional : true
If id is not provided, then email address will be used to identify the member. If neither id nor email is provided, then an error response will be returned.
id integer
  • minimum : 1
  • optional : true
If id is not provided, then email address will be used to identify the member. If neither id nor email is provided, then an error response will be returned.
Remove the member from the specified categories.

Member_Update

Update a member

Parameters

Name Type Rules Description
address string
  • maxLength : 255
  • optional : true
address2 string
  • maxLength : 64
  • optional : true
anniversaryDate string
  • optional : true
  • pattern : (\d{4}-)?\d{2}-\d{2}
This is not affected by useUTC.
birthDate string
  • optional : true
  • pattern : (\d{4}-)?\d{2}-\d{2}
This is not affected by useUTC.
categoryId[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
city string
  • maxLength : 64
  • optional : true
company string
  • maxLength : 255
  • optional : true
customField[] array
  • optional : true

Item Rules

Type Rules
object See Item Properties below

Item Properties

Name Type Rules Description
id integer
  • minimum : 1
  • optional : true
Either the id property or the name property must be given for each custom field.
name string
  • maxLength : 255
  • minLength : 1
  • optional : true
Either the id property or the name property must be given for each custom field.
value string
  • maxLength : 255
  • minLength : 0
If type is date, then use pattern (\d{4}-)?\d{2}-\d{2}
email string
  • format : email
  • maxLength : 64
  • minLength : 1
  • optional : true
If id is not provided, then email address will be used to identify the member. If neither id nor email is provided, then an error response will be returned.
fax string
  • maxLength : 64
  • optional : true
firstName string
  • maxLength : 64
  • optional : true
gender string
  • maxLength : 64
  • optional : true
id integer
  • minimum : 1
  • optional : true
If id is not provided, then email address will be used to identify the member. If neither id nor email is provided, then an error response will be returned.
lastName string
  • maxLength : 64
  • optional : true
mobilePhone string
  • maxLength : 64
  • optional : true
phone string
  • maxLength : 64
  • optional : true
replaceCategories string
  • default : all
  • enum : ["none", "publicOnly", "except", "all"]
  • optional : true
replaceCustomFieldData boolean
  • default : true
  • optional : true
state string
  • maxLength : 64
  • optional : true
status string
  • enum : ["active", "deactivated"]
  • optional : true
triggerAutoSenders boolean
  • default : true
  • optional : true
Indicates whether auto senders will be triggered for categories that were added to the member.
zip string
  • maxLength : 64
  • optional : true
Updates a member.

PublicAppProperties_Retrieve

Retrieves the application configuration

Parameters

Name Type Rules Description
templateId integer
  • minimum : 1
  • optional : true
userId integer
  • minimum : 1
  • optional : true
Retrieves the application configuration.

Test_Ping

Unauthenticated ping

Parameters

None

Returns nothing but a success code. Used for testing connectivity only.

User_Add

Add a user

Parameters

Name Type Rules Description
accountRepDisplayEnabled boolean
  • default : true
  • optional : true
accountRepId integer
  • minimum : 1
  • optional : true
accountType string
  • default : unmanaged
  • enum : ["managed", "unmanaged"]
  • optional : true
If a parent user is specified and the parent user is unmanaged, then accountType is ignored and always set to unmanaged.
anniversaryCampaignsEnabled boolean
  • default : false
  • optional : true
billingCity string
  • maxLength : 64
  • minLength : 1
billingCompanyName string
  • maxLength : 64
  • minLength : 1
billingPhone string
  • maxLength : 32
  • optional : true
billingState string
  • enum : ["Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other"]
  • maxLength : 32
  • minLength : 1
billingStreetAddress string
  • maxLength : 64
  • minLength : 1
billingZIPCode string
  • maxLength : 32
  • minLength : 1
birthdayCampaignsEnabled boolean
  • default : false
  • optional : true
businessCategory[] array
  • minItems : 1

Item Rules

Type Rules
string
  • enum : ["Arts and Artists","Banking","Bar","Business and Finance","Chambers and Networking","Computers and Electronics","Construction","Consulting","Corporate","eCommerce","Education and Training","Entertainment","Events","Financial","Golf Course","Government","Health and Fitness","Hobbies","Home and Garden","Hospitality","Insurance","Legal","Marketing and Advertising","Media and Publishing","Medical/Healthcare and Dental","Music and Musicians","Night Club","Non Profit","Other","Photo and Video","Politics","Professional Services","Public Relations","Real Estate","Recruitment and Staffing","Religion","Restaurant","Retail","Schools and Universities","Service","Social Networks and Online Communities","Software and Web Applications","Sports","Telecommunications","Travel and Transportation","Wedding","Wholesale"]
businessCity string
  • maxLength : 64
  • minLength : 1
businessFax string
  • maxLength : 32
  • optional : true
businessName string
  • maxLength : 64
  • minLength : 1
businessPhone string
  • maxLength : 32
  • optional : true
businessState string
  • enum : ["Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other"]
  • maxLength : 32
  • minLength : 1
businessStreetAddress string
  • maxLength : 64
  • minLength : 1
businessZIPCode string
  • maxLength : 32
  • minLength : 1
campaignSharing boolean
  • default : false
  • optional : true
clickthroughTrackingEnabled boolean
  • default : true
  • optional : true
contactEmail[] array
  • minItems : 1

Item Rules

Type Rules
string
  • format : email
  • maxLength : 64
  • minLength : 1
contactFirstName string
  • maxLength : 32
  • minLength : 1
contactLastName string
  • maxLength : 32
  • minLength : 1
dashboardStyle string
  • default : basic
  • enum : ["basic", "advanced"]
  • optional : true
designerDisplayEnabled boolean
  • default : true
  • optional : true
designerId integer
  • minimum : 1
  • optional : true
documentUploadEnabled boolean
  • default : false
  • optional : true
domain string
  • maxLength : 255
  • optional : true
Requires administrator privileges. Only applicable when multiple domains are enabled. A top-level user is allowed to have a different domain than the admin. A sub-user must have the same domain as the parent user.
footerLogoLinkHref string
  • maxLength : 255
  • optional : true
fromEmailAddressVerificationRequired boolean
  • default : true
  • optional : true
initialCampaign object
  • optional : true
  • properties : {"googleAnalytics":{"default":false,"optional":true,"type":"boolean"},"publicDisplay":{"default":false,"optional":true,"type":"boolean"},"name":{"type":"string","maxLength":255},"authentication":{"default":false,"optional":true,"type":"boolean"}}
initialCategory object
  • default : {"publicDisplay":true,"name":"Monthly Newsletter"}
  • optional : true
  • properties : {"publicDisplay":{"default":true,"optional":true,"type":"boolean"},"name":{"minLength":1,"type":"string","maxLength":255}}
mailtoClickthroughTrackingEnabled boolean
  • default : true
  • optional : true
memberDeactivationConsecutiveHardBounceLimit integer
  • default : 1
  • maximum : 5
  • minimum : 1
  • optional : true
memberDoubleOptInRequired boolean
  • default : true
  • optional : true
memberDuplicateDetectionFields string
  • default : email
  • enum : ["email", "firstName,lastName,email"]
  • optional : true
memberExportEnabled boolean
  • default : false
  • optional : true
memberFieldAddress string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldAddress2 string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldCity string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldCompany string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldFax string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldGender string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldMobilePhone string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldPhone string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldState string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberFieldZip string
  • default : private
  • enum : ["private", "public"]
  • optional : true
memberOptInReminderCustomizationEnabled boolean
  • default : false
  • optional : true
memberOptInReminderEnabled boolean
  • default : true
  • optional : true
memberOptInReminderPosition string
  • default : top
  • enum : ["top", "bottom"]
  • optional : true
notes string
  • maxLength : 1000
  • optional : true
parentUserId integer
  • minimum : 0
  • optional : true
Use 0 to indicate that this should be a top-level user.
password string
  • minLength : 1
The password must not measure Weak on the strength test.
templateUploadEnabled boolean
  • default : true
  • optional : true
If accountType is managed, then templateUploadEnabled is ignored and always set to false.
timeZone string
  • default : PST8PDT
  • enum : ["PST8PDT", "EST5EDT", "MST7MDT", "CST6CDT", "America/Phoenix", "Pacific/Honolulu", "America/Anchorage", "Etc/GMT", "Etc/GMT-1", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT-9", "Australia/Adelaide", "Etc/GMT-10"]
  • optional : true
userLogo2URL string
  • optional : true
userLogoURL string
  • optional : true
username string
  • maxLength : 255
  • minLength : 1
verifiedEmailAddress[] array
  • default : []
  • optional : true
This property is ignored without administrator privileges.

Item Rules

Type Rules
string
  • format : email
  • maxLength : 64
  • minLength : 1
websiteURL string
  • maxLength : 64
  • optional : true
welcomeCampaignsEnabled boolean
  • default : false
  • optional : true
Adds a user. Requires administrator privileges.

User_List

List users

Parameters

Name Type Rules Description
id[] array
  • optional : true

Item Rules

Type Rules
integer
  • minimum : 1
Lists users and subusers. Requires administrator privileges. Invoke with no parameters to retrieve entire user list.

User_Update

Update a user

Parameters

Name Type Rules Description
accountRepDisplayEnabled boolean
  • optional : true
accountRepId integer
  • minimum : 1
  • optional : true
accountType string
  • enum : ["managed", "unmanaged"]
  • optional : true
If a parent user is specified and the parent user is unmanaged, then accountType is ignored and always set to unmanaged.
anniversaryCampaignsEnabled boolean
  • optional : true
billingCity string
  • maxLength : 64
  • minLength : 1
  • optional : true
billingCompanyName string
  • maxLength : 64
  • minLength : 1
  • optional : true
billingPhone string
  • maxLength : 32
  • optional : true
billingState string
  • enum : ["Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other"]
  • maxLength : 32
  • minLength : 1
  • optional : true
billingStreetAddress string
  • maxLength : 64
  • minLength : 1
  • optional : true
billingZIPCode string
  • maxLength : 32
  • minLength : 1
  • optional : true
birthdayCampaignsEnabled boolean
  • optional : true
businessCategory[] array
  • minItems : 1
  • optional : true

Item Rules

Type Rules
string
  • enum : ["Arts and Artists","Banking","Bar","Business and Finance","Chambers and Networking","Computers and Electronics","Construction","Consulting","Corporate","eCommerce","Education and Training","Entertainment","Events","Financial","Golf Course","Government","Health and Fitness","Hobbies","Home and Garden","Hospitality","Insurance","Legal","Marketing and Advertising","Media and Publishing","Medical/Healthcare and Dental","Music and Musicians","Night Club","Non Profit","Other","Photo and Video","Politics","Professional Services","Public Relations","Real Estate","Recruitment and Staffing","Religion","Restaurant","Retail","Schools and Universities","Service","Social Networks and Online Communities","Software and Web Applications","Sports","Telecommunications","Travel and Transportation","Wedding","Wholesale"]
businessCity string
  • maxLength : 64
  • minLength : 1
  • optional : true
businessFax string
  • maxLength : 32
  • optional : true
businessName string
  • maxLength : 64
  • minLength : 1
  • optional : true
businessPhone string
  • maxLength : 32
  • optional : true
businessState string
  • enum : ["Alabama", "AL", "Alaska", "AK", "Alberta", "AB", "American Samoa", "AS", "Arizona", "AZ", "Arkansas", "AR", "British Columbia", "BC", "California", "CA", "Colorado", "CO", "Connecticut", "CT", "Delaware", "DE", "District of Columbia", "DC", "Florida", "FL", "Georgia", "GA", "Guam", "GU", "Hawaii", "HI", "Idaho", "ID", "Illinois", "IL", "Indiana", "IN", "Iowa", "IA", "Kansas", "KS", "Kentucky", "KY", "Louisiana", "LA", "Maine", "ME", "Manitoba", "MB", "Maryland", "MD", "Massachusetts", "MA", "Michigan", "MI", "Minnesota", "MN", "Mississippi", "MS", "Missouri", "MO", "Montana", "MT", "Nebraska", "NE", "Nevada", "NV", "New Brunswick", "NB", "New Hampshire", "NH", "New Jersey", "NJ", "New Mexico", "NM", "New York", "NY", "Newfoundland", "NL", "North Carolina", "NC", "North Dakota", "ND", "Northern Mariana Islands", "MP", "North West Territory", "NT", "Nova Scotia", "NS", "Ohio", "OH", "Oklahoma", "OK", "Ontario", "ON", "Oregon", "OR", "Pennsylvania", "PA", "Puerto Rico", "PR", "Quebec", "QC", "Rhode Island", "RI", "Saskatchewan", "SK", "South Carolina", "SC", "South Dakota", "SD", "Tennessee", "TN", "Texas", "TX", "Trust Territories", "TT", "Utah", "UT", "Vermont", "VT", "Virgin Islands", "VI", "Virginia", "VA", "Washington", "WA", "West Virginia", "WV", "Wisconsin", "WI", "Wyoming", "WY", "Yukon", "YT", "Other"]
  • maxLength : 32
  • minLength : 1
  • optional : true
businessStreetAddress string
  • maxLength : 64
  • minLength : 1
  • optional : true
businessZIPCode string
  • maxLength : 32
  • minLength : 1
  • optional : true
campaignSharing boolean
  • optional : true
clickthroughTrackingEnabled boolean
  • optional : true
contactEmail[] array
  • minItems : 1
  • optional : true

Item Rules

Type Rules
string
  • format : email
  • maxLength : 64
  • minLength : 1
contactFirstName string
  • maxLength : 32
  • minLength : 1
  • optional : true
contactLastName string
  • maxLength : 32
  • minLength : 1
  • optional : true
dashboardStyle string
  • enum : ["basic", "advanced"]
  • optional : true
designerDisplayEnabled boolean
  • optional : true
designerId integer
  • minimum : 1
  • optional : true
documentUploadEnabled boolean
  • optional : true
domain string
  • maxLength : 255
  • optional : true
Requires administrator privileges. Only applicable when multiple domains are enabled. A top-level user is allowed to have a different domain than the admin. A sub-user must have the same domain as the parent user.
footerLogoLinkHref string
  • maxLength : 255
  • optional : true
fromEmailAddressVerificationRequired boolean
  • optional : true
id integer
  • minimum : 1
mailtoClickthroughTrackingEnabled boolean
  • optional : true
memberDeactivationConsecutiveHardBounceLimit integer
  • maximum : 5
  • minimum : 1
  • optional : true
memberDoubleOptInRequired boolean
  • optional : true
memberDuplicateDetectionFields string
  • enum : ["email", "firstName,lastName,email"]
  • optional : true
memberExportEnabled boolean
  • optional : true
memberFieldAddress string
  • enum : ["private", "public"]
  • optional : true
memberFieldAddress2 string
  • enum : ["private", "public"]
  • optional : true
memberFieldCity string
  • enum : ["private", "public"]
  • optional : true
memberFieldCompany string
  • enum : ["private", "public"]
  • optional : true
memberFieldFax string
  • enum : ["private", "public"]
  • optional : true
memberFieldGender string
  • enum : ["private", "public"]
  • optional : true
memberFieldMobilePhone string
  • enum : ["private", "public"]
  • optional : true
memberFieldPhone string
  • enum : ["private", "public"]
  • optional : true
memberFieldState string
  • enum : ["private", "public"]
  • optional : true
memberFieldZip string
  • enum : ["private", "public"]
  • optional : true
memberOptInReminderCustomizationEnabled boolean
  • optional : true
memberOptInReminderEnabled boolean
  • optional : true
memberOptInReminderPosition string
  • enum : ["top", "bottom"]
  • optional : true
notes string
  • maxLength : 1000
  • optional : true
parentUserId integer
  • minimum : 0
  • optional : true
Use 0 to indicate that this should be a top-level user.
password string
  • minLength : 1
  • optional : true
The password must not measure Weak on the strength test.
templateUploadEnabled boolean
  • optional : true
If accountType is managed, then templateUploadEnabled is ignored and always set to false.
timeZone string
  • enum : ["PST8PDT", "EST5EDT", "MST7MDT", "CST6CDT", "America/Phoenix", "Pacific/Honolulu", "America/Anchorage", "Etc/GMT", "Etc/GMT-1", "Etc/GMT-2", "Etc/GMT-3", "Etc/GMT+3", "Etc/GMT+4", "Etc/GMT+5", "Etc/GMT-9", "Australia/Adelaide", "Etc/GMT-10"]
  • optional : true
userLogo2URL string
  • optional : true
userLogoURL string
  • optional : true
username string
  • maxLength : 255
  • minLength : 1
  • optional : true
verifiedEmailAddress[] array
  • optional : true
This property is ignored without administrator privileges.

Item Rules

Type Rules
string
  • format : email
  • maxLength : 64
  • minLength : 1
websiteURL string
  • maxLength : 64
  • optional : true
welcomeCampaignsEnabled boolean
  • optional : true
Updates a user. Requires administrator privileges.

Response Codes

ID Name
0 SUCCESS
1 SYSTEM_ERROR
2 INVALID_ACTION
3 VALIDATION_ERROR
4 AUTH_REQUIRED
5 ACCESS_DENIED
6 AUTH_INVALID_SESSION
7 AUTH_INVALID_USERNAME_AND_PASSWORD
8 AUTH_API_KEY_NOT_FOUND
9 AUTH_API_KEY_EXPIRED
10 AUTH_USER_NOT_ACTIVE
100 APIKEY_INVALID
101 APIKEY_ALREADY_EXPIRED
102 APIKEY_KEY_LIMIT_REACHED
200 MEMBER_INVALID_EMAIL_ADDRESS
201 MEMBER_INVALID_CATEGORY
202 MEMBER_ALREADY_EXISTS
203 MEMBER_NO_CATEGORIES
204 MEMBER_LIMIT_EXCEEDED
205 MEMBER_INVALID
206 MEMBER_MULTIPLE_MATCHES
207 MEMBER_INVALID_CUSTOM_FIELD
208 MEMBER_OPT_IN_CONFIRMATION_REQUIRED
209 MEMBER_HONEYPOT_FOUND
300 CATEGORY_NAME_ALREADY_EXISTS
301 CATEGORY_INVALID
302 CATEGORY_LIMIT_EXCEEDED
303 CATEGORY_ORPHANED_MEMBERS_NEED_NEW_CATEGORY
304 CATEGORY_ONE_PUBLIC_CATEGORY_REQUIRED
400 CUSTOM_FIELD_LABEL_ALREADY_EXISTS
401 CUSTOM_FIELD_INVALID
402 CUSTOM_FIELD_LIMIT_EXCEEDED
403 CUSTOM_FIELD_TYPE_NOT_CHANGED
500 CAMPAIGN_NAME_ALREADY_EXISTS
501 CAMPAIGN_INVALID
502 CAMPAIGN_LIMIT_EXCEEDED
503 CAMPAIGN_INVALID_CATEGORY
504 CAMPAIGN_INVALID_MEMBER_LIST
505 CAMPAIGN_NOT_PUBLISHED
506 CAMPAIGN_INVALID_ISSUE_NUMBER
507 CAMPAIGN_INVALID_DELIVERY_DATE
508 CAMPAIGN_MONTHLY_SENDING_LIMIT_EXCEEDED
509 CAMPAIGN_PAST_DELIVERY_DATE
510 CAMPAIGN_ALREADY_SCHEDULED
511 CAMPAIGN_TRIGGERED_EMAIL_REQUIRES_PAID_PLAN
512 CAMPAIGN_TRIGGERED_EMAIL_INVALID_TRIGGER_SETTINGS
513 CAMPAIGN_TRIGGERED_EMAIL_INVALID_CAMPAIGN
514 CAMPAIGN_TRIGGERED_EMAIL_INVALID_ISSUES
515 CAMPAIGN_TRIGGERED_EMAIL_INVALID_CLICK_SETTINGS
516 CAMPAIGN_TRIGGERED_EMAIL_INVALID_CLICK_LINK_TYPE
517 CAMPAIGN_TRIGGERED_EMAIL_INVALID_CLICK_URL
518 CAMPAIGN_TRIGGERED_EMAIL_INVALID_CLICK_RULE_LOGICAL_OPERATOR
519 CAMPAIGN_TRIGGERED_EMAIL_INVALID_CLICK_RULE
520 CAMPAIGN_AB_EMAIL_REQUIRES_PAID_PLAN
521 CAMPAIGN_NOT_SCHEDULED
522 CAMPAIGN_INVALID_END_DATE
523 CAMPAIGN_RECURRING_SENDING_REQUIRES_PAID_PLAN
524 CAMPAIGN_RECURRING_SENDING_REQUIRES_APPROVAL
525 CAMPAIGN_RSS_CONTENT_REQUIRES_PAID_PLAN
526 CAMPAIGN_NONOPENS_SENDING_REQUIRES_PAID_PLAN
527 CAMPAIGN_SOCIALSHARE_AUTOPOST_REFRESH_LINKEDIN_TOKEN
528 CAMPAIGN_SOCIAL_NETWORK_AUTO_POST_REQUIRES_PAID_PLAN
529 CAMPAIGN_MISSING_INCLUDED_MEMBERS
530 CAMPAIGN_NONOPENS_SENDING_SUBJECT_INVALID
531 CAMPAIGN_NONOPENS_SENDING_DELIVERY_DATE_INVALID
532 CAMPAIGN_NONOPENS_SENDING_DELIVERY_DATE_TOO_SOON
600 USER_USERNAME_ALREADY_EXISTS
601 USER_PASSWORD_TOO_WEAK
602 USER_PARENT_USER_INVALID
603 USER_ACCOUNT_REP_INVALID
604 USER_DESIGNER_INVALID
605 USER_ACCOUNT_TYPE_INVALID
606 USER_INVALID
607 USER_DOMAIN_INVALID
608 USER_LOGO_URL_INVALID
609 USER_LOGO_IMAGE_INVALID
610 USER_LOGO_CONNECTION_ERROR
614 USER_LOGO_NOT_FOUND
611 USER_LOGO2_URL_INVALID
612 USER_LOGO2_IMAGE_INVALID
613 USER_LOGO2_CONNECTION_ERROR
614 USER_INCOMPLETE_DATA
615 USER_DKIM_DOMAIN_RECORD_MISSING
616 USER_DKIM_DOMAIN_RECORD_INVALID
617 USER_DKIM_DOMAIN_RECORD_MISMATCH
700 TEMPLATE_NAME_ALREADY_EXISTS
701 TEMPLATE_INVALID
800 TEMPLATE_BOOKMARK_ALREADY_EXISTS
801 TEMPLATE_BOOKMARK_INVALID
900 EMAIL_MESSAGE_IMAGE_NOT_FOUND
1000 DISPLAY_PREFERENCE_INVALID_NAME
1001 DISPLAY_PREFERENCE_INVALID_SIZE
Ideas & Feedback