This API is deprecated.

We have launched a new version of Batchbook and it has its own API which can be found here.

Please do not develop new integrations agains this API! We are leaving it this documentation in place soley as a reference for developers supporting existing integrations with “Batchbook Classic.”

BatchBook API

Related Contacts

Related Contacts is a nested resource that is used to associate a To-Do or a Deal with a Contact. On a Deal, related contacts are displayed as <attached_contacts>. On a Todo, related contacts are displayed as <participants>. Please see Deals and To-Dos for more information on how related contacts are displayed.

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

Add a Contact to a Record

PUT /service/#{records}/#{record_id}/add_related_contact.xml
Attaches a Company or Person record to a Deal or Todo.

Parameters

Option Default Comment
records None Either deals, or todos
record_id None ID of the record being queried

Request

    
      <contact_id>
        1
      </contact_id>
    
  

Response

    
      Status: 200

    
  

Remove a Contact from a Record

DELETE /service/#{records}/#{record_id}/remove_related_contact.xml
Removes an attached Company or Person record from a Deal or Todo.

Parameters

Option Default Comment
records None Either deals, or todos
record_id None ID of the record being queried

Request

    
      <contact_id>
        1
      </contact_id>
    
  

Response

    
      Status: 200