BatchBook API

Home > BatchBook API > Tags

Tags

Uses PUT or DELETE requests to add or remove tags from records.

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.

Methods

• Show
• List All
• Add a tag or tags to a Record
• Remove a tag from a Record

Show

GET /service/tags/#{record_name}.xml
Displays the information for a tag. Note: The id is the tag name.

    
      Status: 200
      <tag>
        <id type="integer">424</id>
        <name>cool</name>
        <supertag type="boolean">false</supertag>
      </tag>
    
  

List All

GET /service/tags.xml
List all tags

    
      Status: 200
      <tags type="array">
        <tag>
          <id type="integer">422</id>
          <name>sample</name>
          <supertag type="boolean">true</supertag>
        </tag>
        <tag>
          <id type="integer">423</id>
          <name>money maker</name>
          <supertag type="boolean">false</supertag>
        </tag>
        <tag>
          <id type="integer">424</id>
          <name>cool</name>
          <supertag type="boolean">false</supertag>
        </tag>
      </tags>
    
  

Add Tag

PUT /service/#{records}/#{record_id}/add_tag.xml
Adds a tag or tags to a Person, Company, Deal, Communication or Todo

    
      <tag>
        awesome
      </tag>
    
    
or
      
      <tags>
        important,fun,another tag
      </tags>
      
    
or
      
        <tags type='array'>
          <tag>
            awesome
          </tag>
          <tag>
            great
          </tag>
          <tag>
            tiring
          </tag>
        </tags>
      
  

    
      Status: 200
      
    
  

Remove Tag

DELETE /service/#{records}/#{record_id}/remove_tag.xml
Removes a tag or tags to a Person, Company, Deal, Communication or Todo

    
      <tag>
        awesome
      </tag>
    
  

    
      Status: 200