Retrieve a specific comment by its id.
<comment>
...
</comment>
Return the list of comments associated with the specified message.
<comments>
<comment>
...
</comment>
<comment>
...
</comment>
...
</comments>
Create a new comment, associating it with a specific message.
<request>
<comment>
<post-id>#{post_id}</post-id>
<body>#{body}</body>
</comment>
</request>
---
comment:
post-id: #{post_id}
body: #{body}
<comment>
...
</comment>
Creates a new message, optionally sending notifications to a selected list of people. Note that you can also upload files using this function, but you need to upload the files first and then attach them. See the description at the top of this document for more information.
<request>
<post>
<category-id>#{category_id}</category-id>
<title>#{title}</title>
<body>#{body}</body>
<extended-body>#{extended_body}</extended-body>
<use-textile>1</use_textile> <!-- omit to not use textile -->
<private>1</private> <!-- only for firm employees -->
</post>
<notify>#{person_id}</notify>
<notify>#{person_id}</notify>
...
<attachments>
<name>#{name}</name> <!-- optional -->
<file>
<file>#{temp_id}</file> <!-- the id of the previously uploaded file -->
<content-type>#{content_type}</content-type>
<original_filename>#{original_filename}</original-filename>
</file>
</attachments>
<attachments>...</attachments>
...
</request>
---
post:
category-id: #{category_id}
title: #{title}
body: #{body}
extended-body: #{extended_body}
use-textile: #{true|false}
private: #{true|false}
notify:
- #{person_id}
- #{person_id}
...
attachments:
- name: #{name}
file:
file: #{temp_id}
content-type: #{content_type}
original-filename: #{original_filename}
...
<post>
...
</post>
Delete the comment with the given id.
<comment>
...
</comment>
Delete the specified message from the project.
<post>
...
</post>
This will return information about the referenced message. If the id is given as a comma-delimited list, one record will be returned for each id. In this way you can query a set of messages in a single request. Note that you can only give up to 25 ids per request--more than that will return an error.
<posts>
<post>
...
</post>
<post>
...
</post>
...
</posts>
This will return a summary record for each message in a project. If you specify a category_id, only messages in that category will be returned. (Note that a summary record includes only a few bits of information about a post, not the complete record.)
<request>
<project-id>#{project_id}</project-id>
<!-- optional -->
<category-id>#{optional_category_id}</category-id>
</request>
---
project-id: #{project_id}
# optional
category-id: #{optional_category_id}
<posts>
<post>
... <!-- abbreviated post -->
</post>
<post>
... <!-- abbreviated post -->
</post>
...
</posts>
This will return a summary record for each message in a particular category. (Note that a summary record includes only a few bits of information about a post, not the complete record.)
<posts>
<post>
... <!-- abbreviated post -->
</post>
<post>
... <!-- abbreviated post -->
</post>
...
</posts>
Update a specific comment. This can be used to edit the content of an existing comment.
<request>
<comment_id>#{comment_id}</comment_id>
<comment>
<body>#{body}</body>
</comment>
</request>
---
comment_id: #{comment_id}
comment:
body: #{body}
<comment>
...
</comment>
Updates an existing message, optionally sending notifications to a selected list of people. Note that you can also upload files using this function, but you have to format the request as multipart/form-data. (See the ruby Basecamp API wrapper for an example of how to do this.)
<request>
<post>
<category-id>#{category_id}</category-id>
<title>#{title}</title>
<body>#{body}</body>
<extended-body>#{extended_body}</extended-body>
<use-textile>1</use-textile> <!-- omit to not use textile -->
<private>1</private> <!-- only for firm employees -->
</post>
<notify>#{person_id}</notify>
<notify>#{person_id}</notify>
...
</request>
---
post:
category-id: #{category_id}
title: #{title}
body: #{body}
extended-body: #{extended_body}
use-textile: #{true|false}
private: #{true|false}
notify:
- #{person_id}
- #{person_id}
...
<post>
...
</post>