BatchBook API

Comments

BatchBook Comments can be attached to People, Companies, Deals, To-Dos, and Communications. Comments have been set up as a nested resource to each of the other resources and are standard REST implementations with support for GET/PUT/DELETE requests. Creation of a Comment must be done as nested resource.

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
  • Update
  • Destroy
  • Show a Comment for a Record
  • List all Comments for a Record
  • Create a Comment
  • Update a Comment on a Record
  • Delete a Comment

    • Show

    GET /service/comments/#{id}.xml

    Response

        
      Status: 200
      
      <mega_comment>
        <id type="integer">199</id>
        <comment>Best comment ever</comment>
        <user>Eric Krause</user>
        <created_at type="datetime">2010-10-10 15:06:27 -0400</created_at>
        <record_id type="integer">64019</record_id>
      </mega_comment>

    List All

    GET /service/comments.xml

    Parameters

    Option Default Comment
    page 1 Comments are broken into pages of 10.

    Response

        
      Status: 200
      <mega_comments type="array">
        <mega_comment>
          ...
        </mega_comment>
        <mega_comment>
          ...
        </mega_comment>
      </mega_comments>

    Update

    PUT /service/comments/#{id}.xml
    Note: Please note the nested Comment tags. They will be deprecated in a future version of the API.

    Request

        
      <comment>
        <comment>
          A Simple Comment
        </comment>
      </comment>

    Response

        
      Status: 200

    Destroy

    DELETE /service/comments/#{id}.xml
    Destroys the comment at the referenced url.

    Response

        
      Status: 200

    Show a Comment on a Record

    GET /service/#{records}/#{record_id}/comments/#{id}.xml
    Same functionality as Show Comment.

    Response

        
      Status: 200
      
      <mega_comment>
        <id type="integer">199</id>
        <comment>Best comment ever</comment>
        <user>Eric Krause</user>
        <created_at type="datetime">2010-10-10 15:06:27 -0400</created_at>
        <record_id type="integer">64019</record_id>
      </mega_comment>

    List All Comments for a Record

    GET /service/#{records}/#{record_id}/comments.xml
    Returns all comments for a Record. The record could be either deals, todos, companies, people, or communications. Comments are also returned as part of the SHOW action for the above resources.

    Response

        
      Status: 200
      <mega_comments type="array">
        <mega_comment>
          ...
        </mega_comment>
        <mega_comment>
          ...
        </mega_comment>
      </mega_comments>

    Create a Comment

    POST /service/#{records}/#{id}/comments.xml
    Creating a comment must be done as nested resource. Note: Please note the nested Comment tags. They will be deprecated in a future version of the API.

    Request

        
      <comment>
        <comment>
          A Simple Comment
        </comment>
      </comment>

    Response

        
      Status: 201
      Location: https://{#accountname}.batchbook.com/service/comments/#{new_comment_id}.xml

    Update a Comment on a Record

    PUT /service/#{records}/#{record_id}/comments/#{id}.xml
    Same functionality as Update Comment. Note: Please note the nested Comment tags. They will be deprecated in a future version of the API.

    Request

        
      <comment>
        <comment>
          A Simple Comment
        </comment>
      </comment>

    Response

        
      Status: 200

    Destroy a Comment on a Record

    DELETE /service/#{records}/#{record_id}/comments/#{id}.xml
    Same functionality as Destroy Comment. Destroys the comment at the referenced url.

    Response

        
      Status: 200