BatchBook API

Home > BatchBook API > SuperTags

SuperTags

The SuperTags service supports list all available SuperTags, as well as fetching the details of a given SuperTag. Currently, it does not support requests to create, update or delete SuperTags.

Methods to add, remove, or set field values for a SuperTag on a given contact can be found in the People and Companies services.

Note: Each of these requests requires that you authenticate with a BatchBook account. This requires an account name and an API token. For more information on authentication, visit the API homepage. For the examples on this page, we will be using the account name "test".

Methods

• List all SuperTags
• Retrieve a SuperTag

List All SuperTags:

To retrieve all the SuperTags in your account, send an HTTP GET request to the SuperTags services URL, identifying the record as below. BatchBook returns an XML representation of the SuperTags.

The feed then returns an HTTP 200 OK status code and an XML representation of the SuperTags.

<?xml version="1.0" encoding="UTF-8"?>
<super_tags type="array">
  <super_tag>
    <name>Social Media</name>
    <fields>
      <field type="Text">Twitter Username</field>
      <field type="Text">Flickr Username</field>
    </fields>
  </super_tag>
  <super_tag>
    <name>Vendor</name>
    <fields>
      <field type="Text">Vendor Code</field>
    </fields>
  </super_tag>
  <super_tag>
    ...
  </super_tag>	
</super_tags>

Show:

To fetch a specific SuperTag, send an HTTP GET request to a link constructed from the SuperTag's name, like the following:

The server then returns an HTTP 200 OK status code and an entry containing the SuperTag.

<?xml version="1.0" encoding="UTF-8"?>
<super_tag>
  <name>Social Media</name>
  <fields>
    <field type="Text">Twitter Username</field>
    <field type="Text">Flickr Username</field>
  </fields>
</super_tag>