Represents a case file that is stored in Capsule.
Name | Type | Description | |
---|---|---|---|
id | Long | Read only |
The unique id of this case. |
party | Nested Party | Required |
The main contact for this case. |
name | String | Required |
The name of this case. |
description | String |
The description of this case. |
|
owner | Nested User |
The user this case is assigned to. This and/or |
|
team | Nested Team |
The team this case is assigned to. This and/or |
|
status | String |
The status of the case. Accepted values are: |
|
opportunity | Nested Opportunity |
An optional link to the opportunity that this case was created to support. |
|
createdAt | Date | Read only |
The ISO date/time when this case was created. |
updatedAt | Date | Read only |
The ISO date/time when this case was last updated. |
expectedCloseOn | Date |
The expected close date of this case. |
|
closedOn | Date | Read only |
The ISO date when this case was closed. |
lastContactedAt | String | Read only |
The ISO date/time when this case was last contacted. This field is automatically set by Capsule based on the attached history entries. |
tags | Array of Nested Tag |
An array of tags that are added to this case. This field is included in responses only if the
|
|
fields | Array of Field Value |
An array of custom fields that are defined for this case. This field is included in responses
only if the |
|
missingImportantFields | Boolean |
Indicates if this case has any Important custom fields that are missing a value. This field is included in responses only if the |