Back to the Developer home page
Returns a single email. Attachments are included, but comments are kept separate at /emails/#{id}/comments.xml.
Status: 200 OK
<email>
<id type="integer">7</id>
<subject-id type="integer">4</subject-id>
<subject-type>Party</subject-type>
<title>Regarding the purchase</title>
<body>It's very important</body>
<kase-id type="integer"></kase-id>
<updated-at type="datetime">2007-02-27T18:42:28Z</updated-at>
<created-at type="datetime">2006-05-16T17:26:00Z</created-at>
<visible-to>NamedGroup</visible-to>
<group-id type="integer">1</group-id>
<owner-id type="integer"></owner-id>
<author-id type="integer">3</author-id>
<attachments>
<attachment>
<id type="integer">1</id>
<url>http://example.highrisehq.com/files/1</url>
<name>picture.png</name>
<size type="integer">72633</name>
</attachment>
<attachment>
<id type="integer">2</id>
<url>http://example.highrisehq.com/files/2</url>
<name>document.txt</name>
<size type="integer">8837</name>
</attachment>
</attachments>
</email>
Returns a collection of emails that are visible to the authenticated user associated with the person
specified in the URL. The list is paginated using offsets. If 500 elements are returned (the page limit),
use ?n=500 to check for the next 500 and so on.
Status: 200 OK
<emails>
<email>
...
</email>
<email>
...
</email>
</emails>
Returns a collection of emails like List All From Person, but from a company instead. This includes all
emails that are associated with employees of the company.
Status: 200 OK
<emails>
<email>
...
</email>
<email>
...
</email>
</emails>
Returns a collection of emails like List All From Person, but from a case instead. This includes all
emails that are associated specifically with the case or with a party and the case.
Status: 200 OK
<emails>
<email>
...
</email>
<email>
...
</email>
</emails>
Creates a new email with the currently authenticated user as the author.
The subject of the email (who it belongs to) can either be set through the url or through the
subject-type and subject-id tags. Using /companies/5/emails.xml as the target for the POST is the same as
using /emails.xml with subject-type “Party” and subject-id “5”.
By default, a new email is assumed to be visible to Everyone. You can also chose to make the email only
visible to the creator using “Owner” as the value for the visible-to tag. Or “NamedGroup” and pass in a group-id
tag too.
Note: Adding attachments to a email is not yet supported.
<email>
<title>Regarding the purchase</title>
<body>I just wanted to talk to you about the purchase.</body>
<subject-id type="integer">4</subject-id>
<subject-type>Party</subject-type>
</email>
Status: 201 Created
Location: http://example.highrisehq.com/emails/#{new-email-id}.xml
<email>
...
</email>
Updates an existing email with new details from the submitted XML.
<email>
<body>Hello world is now part of a case!</body>
<kase-id type="integer">1</kase-id>
</email>
Status: 200 OK
Destroys the email at the referenced URL.
Status: 200 OK