1. Home
  2. Docs
  3. REST API
  4. API Reference
  5. Custom Fields and Tags

Custom Fields and Tags

Provides detailed information on the fields and tags in an account, and the value(s) assigned to an individual within the account.

IMPORTANT: If all you want to do is set or clear values, we suggest that you consider using the “Simple” API call instead, at https://developer.feedblitz.com/docs/simple-api/setting-tags-and-custom-fields/

Custom fields in FeedBlitz are data points beyond the subscriber’s email that are available to the account. There are no limits to the number of custom fields in a single account; they are currently global to the entire account, however. Field data are stored encrypted using AES.

In the FeedBlitz UI we also refer to “tags” – labels that are associated with a subscriber. Tags are stored internally with the value “1” to indicate that the label is applied.

The following resources are supported. Currently, only the GET method is supported.

Resource: /fields

Returns XML metadata for the fields defined by the account:

<?xml version="1.0" encoding="UTF-8"?>
  <feedblitzapi version="1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
<rsp stat="ok">
<success code="0" msg="Authorized" />
</rsp>
  <fields>
    <count>1</count>
    <field>
      <id>234956</id>
      <name>ReferrerName</name>
      <type>string</type>
      <default />
      <order>2</order>
      <required>0</required>
      <hidden>0</hidden>
      <description>Who referred you?</description>
      <help>Did a current member of program give you your special invite? If so, please enter their name here so they receive proper credit.</help>
      <created>2015-07-28 19:18:04 -0500</created>
      <updated>2015-07-28 19:22:13 -0500</updated>
    </field>
  </fields>
</feedblitzapi>

Resource: /fields/id/<fieldid>

Returns field metadata for a single field ID, as in:

/fields/id/234956

Resource: /fieldvalues/subscriber/<subscriberid>

Returns the field values stored in the account for the given subscriber, as in:

/fieldvalues/subscriber/26562441

The returned XML lists all the fields associated with the account, and then any values found for the given subscriber ID.

Sample returned XML:

<?xml version="1.0" encoding="UTF-8"?>
<feedblitzapi version="1.0" xmlns:xlink="http://www.w3.org/1999/xlink">
<rsp stat="ok">
<success code="0" msg="Authorized" />
</rsp>
  <fields>
    <count>1</count>
    <field>
      <id>14473</id>
      <name>DateAdded</name>
      <type>date</type>
      <default>1969/07/04</default>
      <order>0</order>
      <required>0</required>
      <hidden>1</hidden>
      <description />
      <help />
      <created>2013-11-05 18:36:29 -0500</created>
      <updated>2013-11-05 18:36:29 -0500</updated>
    </field>
  </fields>
  <subscribers>
    <count>1</count>
    <subscriber>
      <email>feedmanager@example.com</email>
      <publishervalues>
        <count>1</count>
        <fieldvalue>
          <id>32605820</id>
          <fieldid>14473</fieldid>
          <name>DateAdded</name>
          <value>1969/07/04</value>
          <created>2015-07-24 10:54:57 -0500</created>
          <updated>2015-07-24 10:54:57 -0500</updated>
        </fieldvalue>
      </publishervalues>
    </subscriber>
  </subscribers>
</feedblitzapi>