account.addCustomField

name

The name of the new custom field to be added.

string

Yes

Sign Up Date

type

The data type of the new custom field to be added. The values for this field include either of the following:

• date

• string

• number

• zip_code

string

Yes

date

format

This element defines how the field value will be displayed within the body of an email when used as a personalization tag. What appears in this element

depends upon the <type>.If <type> is defined as date, the value of this element must be defined as either of the following options:

• MM/DD/YYYY

• DD/MM/YYYY

• FMMonth ddth, YYYY (example: December 31st, 2010)

• FMMonth ddth

• YYYY-MM-DD

If <type> is defined as string, the value of this element is set to "string".

If <type> is defined as number, this element must contain two sub-elements where:

string

Conditional;

Required only if <type> is defined as either date or number.

DD/MM/YYYY

display_on_survey

A boolean value that defines whether the new custom field should be displayed in the standard survey web page (or the custom survey web page) where applicable.

Boolean where:

• 0 – do not display (default)

• 1 – display

NOTE: Numeric custom fields never appear in survey pages, regardless of the value passed here.

No

1

friendly_tag

Defines the "friendly tag" name, typically referenced within the email body for personalization. To view a list of existing friendly tag names within the application, log in and navigate to Assets > Manage Custom Fields and then look in the "Friendly Tag" column of the screen.

string

No

signupDate

default_value

Sets the default value of the new custom field displayed within the email's body when the subscriber's contact record does not include a value for this custom field.

string

No

01/01/2011

responseCode

A code indicating either the success or failure of the operation. (see Error Codes below)

133

responseText

Human readable description of the response code

This custom field has been added

id

If successful operation, this element will be set to the ID number identifying the newly added custom field. If unsuccessful operation, the value of this element will be zero.

1055589

name

The name of the custom field as provided by the input XML message.

Sign Up Date

type

The field type as provided by the input XML message.

date

format

The format as provided by the input XML message

DD/MM/YYYY

display_on_survey

A boolean value that defines whether the newly added custom field should be displayed in the standard survey web page (or the custom survey web page) where applicable, as provided by the input XML message. If unsuccessful operation, this element will be set to the default value of zero.

1

friendly_tag

The "friendly tag" name which is typically referenced within the email body for personalization as provided in the input XML message

signupDate

default_value

The default value of the new custom field displayed within the email's body when the subscriber's contact record does not include a value for this custom field.

Missing <format> element when the <type> element is set to "date".

130

action not taken, the format required when type is date

The value for the <format> element is incorrect according to the specification.

131

action not taken, invalid format

The name of the custom field already exists. Field names must be unique

132

action not taken, field name already exists

Successful operation

133

this custom field has been added

Missing <format> element when the <type> element is set to "number".

136

action not taken, the format required when type is number