Highrise API

Categories (Tasks, Deals)

The categories API is identical for both Task categories, and Deal categories, the only difference being the URL. For Task categories, the API should be prefixed with "task_categories", and for Deal categories, "deal_categories". In the documentation that follows, the generic "#{type}_categories" will be used, but you should replace that with the category collection you wish to query.

Show

GET /#{type}_categories/#{id}.xml

Return a single category record.

Response

Status: 200 OK

<#{type}-category>
  <id type="integer"></id>
  <name></name>
  <account-id type="integer"></account-id>
  <created-at type="datetime"></created-at>
  <updated-at type="datetime"></updated-at>
  <elements-count type="integer"></elements-count>
</#{type}-category>

List

GET /#{type}_categories.xml

Return all categories

Response

Status: 200 OK

<#{type}-categories type="array">
  <#{type}-category>
    ...
  </#{type}-category>
  ...
</#{type}-categories>

Create

POST /#{type}_categories.xml

Create a new category

Request

<#{type}-category>
  <name>#{name}</name>
</#{type}-category>

Response

Status: 201 Created
Location: http://example.highrisehq.com/#{type}_categories/#{new-id}.xml

Update

PUT /#{type}_categories/#{id}.xml

Update (rename) an existing category

Request

<#{type}-category>
  <name>#{name}</name>
</#{type}-category>

Response

Status: 200 OK

Destroy

DELETE /#{type}_categories/#{id}.xml

Destroy a category. Note that you can only destroy categories that
are empty (i.e., they contain no deals, for deal categories, or tasks,
for task_categories). Attempting to delete a non-empty category will
result in a 422 (Unprocessable Entity).

Response

Status: 200 OK