People & Organisations (Party)
Party Custom Fields
Party History
Party Tags
Opportunities
Opportunity Additional Parties
Opportunity Custom Fields
Opportunity History
Opportunity Tags
Cases
Case Additional Parties
Case Custom Fields
Case History
Case Tags
Case
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kase>
<id>43</id> <!-- integer -->
<status>CLOSED</status> <!-- OPEN or CLOSED defaults to OPEN -->
<name>Consulting</name> <!-- required -->
<description>Scope and design web site shopping cart</description>
<partyId>2</partyId> <!-- integer, read-only -->
<closeDate>2009-09-30T00:00:00Z</closeDate>
<owner>phillip</owner> <!-- defaulted to authenticated user -->
</kase>
Retrieve a single kase by id.
Retrieve cases where the person or organisation is related to the case.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<kases size="2">
<kase>
...
</kase>
<kase>
...
</kase>
</kase>
List cases. Optionally the results can be limited or paged using the parameters &limit and &start.
List cases by the selected tag. Optionally the results can be limited or paged using the parameters &limit and &start.
Return case records that have been updated or created since the modified since date supplied. The modified since date should be in the format YYYYMMDDTHHMMSS, eg. Midnight June 31, 2009 GMT would be 20090631T000000. Optionally the results can be limited or paged using the parameters &limit and &start.
Create a new case attached to this person or organisation.
Example request:
<?xml version="1.0"?>
<kase>
<name>Website design</name>
<description>Design and create website</description>
<owner>jdoe</owner>
</kase>
Example response:
HTTP/1.1 201 Created
Location: https://test1.capsule.com/api/kase/59
Update the case, if moving the case to another person or organisation use the alternative party version of the URL. case.
Example request:
<?xml version="1.0"?>
<kase>
<status>CLOSED</status>
</kase>