User Guide

48 Chapter 4: Action Reference
field-id The ID of the field to be updated (can be obtained by calling action custom-
fields
). This parameter needs to be specified only when updating an existing field.
name The name of the custom field (may be 1 to 60 characters long).
comments Any comments on the custom field (may be 0 to 60 characters long). This parameter
is optional.
type The type of the custom field. Must be one of the following:
custom-seq The custom field number. Specify this parameter only when creating a new
custom field (should be one more than the current maximum value of
custom-seq).
Returned elements
When updating an existing custom field: no elements are returned.
When creating a new custom field:
field.
Sample Results:
When creating a new custom field:
<results>
<status code="ok" />
<field field-id="1562" account-id="7" custom-seq="4"
type="optional">
<comments>none</comments>
<name>Manager</name>
</field>
</results>
When updating an existing custom field:
<results>
<status code="ok" />
</results>
custom-fields
Description
Lists the custom fields of an account and the details of the fields.
Parameters
accesskey The access key for the account.
Note: The accesskey parameter is required only in Breeze 4.0; it is not required for Breeze 4.1. If you
include this parameter in Breeze 4.1, it is ignored.
Value Description
required
Required account custom field
optional
Optional and show during self-registration
optional-no-self-reg
Optional and hide during self-registration